teamGreg/gregWiki
1
0
Fork 0
mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update documentation layout and links for clarity

Browse Source 
- Revised the documentation layout to reflect updated paths for various sections, including workspace, framework, plugins, mods, tools, guides, releases, reference, contributors, roadmap, topics hub, meta, and legacy.
- Adjusted links to ensure they point to the correct files, enhancing navigation and accessibility within the documentation.
- Improved descriptions in the Mods and Plugins sections to clarify the distinction between gameplay mods and framework plugins.

This commit enhances the overall structure and usability of the documentation.
This commit is contained in:
Marvin
2026-04-10 01:40:00 +02:00
parent b37a0d9078
commit 526a9629ae
5 changed files with 21 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/getting-started/documentation-layout.md
View File

@@ -15,19 +15,19 @@ This folder is the **single source of truth** for the public Docusaurus site. Th
|------|------|--------|
| **Landing** | [`intro` → `/wiki/docs`](/wiki/docs) | Site home. |
| **Getting started** | [`getting-started.md`](../getting-started.md) | Onboarding (`getting-started`) + this layout page. |
| **Workspace** | [`workspace/`](../workspace/) | Map of `gregFramework/` repos on disk. |
| **Framework** | [`framework/`](../framework/) | Architecture, hooks, Hexmod. |
| **Plugins** | [`plugins/`](../plugins/) | `FFM.Plugin.*` wiki pages. |
| **Mods** | [`mods/`](../mods/) | Gameplay mods (`FMF.*`) + framework overview. |
| **Tools** | [`tools/`](../tools/) | Workshop uploader and related. |
| **Guides** | [`guides/`](../guides/) | Role-based paths (players, mod developers, contributors, sponsors). |
| **Releases** | [`releases/`](../releases/) | Per-artifact release notes. |
| **Reference** | [`reference/`](../reference/) | Naming, catalogs, MCP, release channels. |
| **Contributors** | [`contributors/`](../contributors/) | Repo inventory, Docusaurus workflow, design system. |
| **Roadmap** | [`roadmap/`](../roadmap/) | Planning docs. |
| **Topics hub** | [`topics/`](../topics/) | Cross-cutting overviews (assets, multiplayer, security, …). |
| **Meta** | [`meta/`](../meta/) | Workshop tooling notes, devserver API, backlog. |
| **Legacy** | [`legacy/`](../legacy/) | GitHub Wiki mirror under `legacy/wiki-import/`. |
| **Workspace** | [`workspace/`](../workspace/index.mdx) | Map of `gregFramework/` repos on disk. |
| **Framework** | [`framework/`](../framework/architecture.md) | Architecture, hooks, Hexmod. |
| **Plugins** | [`plugins/`](../plugins/index.md) | `FFM.Plugin.*` wiki pages. |
| **Mods** | [`mods/`](../mods/index.md) | Gameplay mods (`FMF.*`) + framework overview. |
| **Tools** | [`tools/`](../tools/workshop-uploader.md) | Workshop uploader and related. |
| **Guides** | [`guides/`](../guides/players/overview.md) | Role-based paths (players, mod developers, contributors, sponsors). |
| **Releases** | [`releases/`](../releases/index.mdx) | Per-artifact release notes. |
| **Reference** | [`reference/`](../reference/wiki-mapping.md) | Naming, catalogs, MCP, release channels. |
| **Contributors** | [`contributors/`](../contributors/repo-inventory.md) | Repo inventory, Docusaurus workflow, design system. |
| **Roadmap** | [`roadmap/`](../roadmap/unified-roadmap.md) | Planning docs. |
| **Topics hub** | [`topics/`](../topics/index.md) | Cross-cutting overviews (assets, multiplayer, security, …). |
| **Meta** | [`meta/`](../meta/Steam-Workshop-and-Tooling.md) | Workshop tooling notes, devserver API, backlog. |
| **Legacy** | [`legacy/`](../legacy/index.md) | GitHub Wiki mirror under `legacy/wiki-import/`. |
## Legacy GitHub Wiki (`docs/legacy/wiki-import/`)