mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00

Files

Marvin 526a9629ae docs: update documentation layout and links for clarity

- 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.

2026-04-10 01:40:00 +02:00

3.3 KiB

Raw Blame History

id, title, sidebar_label, description

id	title	sidebar_label	description
documentation-layout	Documentation layout (`docs/`)	Documentation layout	How curated docs, guides, and the legacy GitHub Wiki mirror 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.*` wiki pages.
Mods	`mods/`	Gameplay mods (`FMF.*`) + framework overview.
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, 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.
Legacy	`legacy/`	GitHub Wiki mirror under `legacy/wiki-import/`.

Legacy GitHub Wiki (`docs/legacy/wiki-import/`)

Long-form pages mirrored from the GitHub Wiki live here (synced from .wiki/).

Clone the wiki working tree as ../.wiki/ under gregFramework/ (same level as sibling repos).
From gregWiki root: npm run wiki:refresh (or wiki:sync → wiki:normalize-i18n).
German paired pages live under i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ after normalization.
Prefer new curated docs under guides/, reference/, or framework/; keep bulk legacy material in legacy/wiki-import/ until migrated.

Details: topics/wiki-import/overview.

URLs

Doc id intro → /wiki/docs.
Typical doc → /wiki/<doc-id-path> (e.g. mods/framework → /wiki/mods/framework).

Scripts (gregWiki root)

Script	Role
`wiki:sync`	Copies `.wiki/` → `docs/legacy/wiki-import/`.
`wiki:normalize-i18n`	Splits DE/EN pairs into default locale + `i18n/de/...`.
`write-wiki-import-category-keys`	Refreshes `_category_.json` keys under imported trees.

Locales

Default: en — files under docs/.
Deutsch: overrides under i18n/de/docusaurus-plugin-content-docs/current/ mirroring docs/ paths.
fr, es, ru, ja: fallback to English where no file exists.

3.3 KiB Raw Blame History

Documentation layout (docs/)