mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-10 19:19:18 +02:00
9605741570
- Revised the `getting-started.md` and `documentation-layout.md` files to improve clarity and organization of content. - Enhanced descriptions and added tables for better readability in the `getting-started.md` file. - Updated the `greg-hooks-registry.md` to reflect changes in the hook mapping and clarify the role of `greg_hooks.json`. - Adjusted the `fmf-hook-naming.md` and `fmf-hooks-catalog.md` to emphasize the transition from legacy naming conventions to the new `greg.*` format. This commit aims to improve the overall clarity and usability of the documentation, ensuring users have a better understanding of the framework and its components.
2.6 KiB
2.6 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 |
Mod author wiki home (slug: / under the docs plugin). |
| 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/ |
GregModManager (Gregtools Modmanager / WorkshopUploader project). |
| Guides | guides/ |
Players live on /players; this tree is mod developers, contributors, sponsors. |
| Releases | releases/ |
Per-artifact release notes. |
| Reference | reference/ |
Naming, catalogs, 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(slug: /; legacy/wiki/docsredirects here). - 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.