mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
ee3f30e502
- Added new items to the sidebar for 'greg-hooks-and-events' and 'greg-hooks-registry' under the Framework and Reference categories, respectively. - Enhanced the documentation layout by including references to the greg hooks registry in various guides and topics, improving accessibility to hook-related information. - Updated descriptions in the documentation to clarify the purpose and usage of the greg hooks and their registry. This commit aims to improve the visibility and usability of the greg hooks registry within the documentation.
4.4 KiB
4.4 KiB
id, title, sidebar_label, description
| id | title | sidebar_label | description |
|---|---|---|---|
| documentation-layout | Documentation layout (`docs/`) | Documentation layout | How curated docs, guides, and reference material are organized under docs/. |
Documentation layout (docs/)
This folder is the single source of truth for the public Docusaurus site. The app lives in the gregWiki repository root next to docs/; pages are served under the /wiki base path.
How content is organized
| Area | Path | Purpose |
|---|---|---|
| Landing | intro → /wiki/docs |
Site home. |
| Getting started | getting-started.md |
Onboarding (getting-started) + this layout page. |
| Workspace | workspace/ |
Map of gregFramework/ repos on disk. |
| Framework | framework/ |
Architecture, hooks, Hexmod. |
| Plugins | plugins/ |
FFM.Plugin.* assemblies; repos gregExt.* on disk. |
| Mods | mods/ |
Gameplay mods (FMF.*); repos gregMod.* on disk. |
| Tools | tools/ |
Workshop uploader and related. |
| Guides | guides/ |
Role-based paths (players, mod developers, contributors, sponsors). |
| Releases | releases/ |
Per-artifact release notes. |
| Reference | reference/ |
Naming, catalogs, greg_hooks registry, MCP, release channels. |
| Contributors | contributors/ |
Repo inventory, Docusaurus workflow, design system. |
| Roadmap | roadmap/ |
Planning docs. |
| Topics hub | topics/ |
Cross-cutting overviews (assets, multiplayer, security, …). |
| Meta | meta/ |
Workshop tooling notes, devserver API, backlog; architecture principles (stack model & doc rules). |
URLs
- Doc id
intro→/wiki/docs. - Typical doc →
/wiki/<doc-id-path>(e.g.mods/framework→/wiki/mods/framework).
Language
- English only — all curated content lives under
docs/.
Historical note
The former GitHub Wiki bulk import under docs/legacy/wiki-import/ has been removed. Author new material under the folders above; use Git history if you need obsolete text.