mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-10 19:19:18 +02:00

Files

Marvin 3b245ee966 docs: refine documentation structure and language consistency

- Updated the tagline in `docusaurus.config.js` for improved clarity.
- Streamlined sidebar navigation items for better organization of player and developer resources.
- Enhanced README and various documentation files to clarify repository layout and improve accessibility.
- Standardized language to English across documentation, ensuring consistency and clarity.
- Removed unnecessary German localization references to focus on English content.

This commit aims to enhance the overall clarity and usability of the documentation.

2026-04-10 02:36:47 +02:00

3.3 KiB

Raw Blame History

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/; built pages are served under the /wiki base path.

How content is organized

Area	Path	Purpose
Landing	`intro` → `/wiki/docs`	Site home (`/wiki/docs`).
Topics hub	`topics/`	Cross-cutting overviews (security, FFI, multiplayer, assets, meta).
Mods & plugins	`mods/`, `plugins/`	Gameplay mods (`FMF.`) and framework plugins (`FFM.Plugin.`).
Releases	`releases/`	Per-artifact release notes.
Reference	`reference/`	Hooks, naming, MCP, generated catalogs.
Contributors	`contributors/`	Repo layout, Docusaurus workflow, design system.
Guides	`guides/`	Role-based paths (players, mod developers, contributors, sponsors).
Roadmap	`roadmap/`	Planning docs.
Meta	`meta/`	Workshop, devserver, backlog; architecture principles (ModManager → Framework → Plugins → Mods).

URLs

Doc id intro → /wiki/docs (see front matter).
Most docs → /wiki/<doc-path> (e.g. mods/framework → /wiki/mods/framework).

Scripts (repository root)

Script	Role
`wiki:sync`	No-op (legacy GitHub Wiki mirror removed).
`wiki:normalize-i18n`	No-op (same).
`wiki:refresh`	Runs both no-ops; safe for old CI hooks.

Author new pages under docs/; use git history if you need text from the former bulk import.

Language

English only — all files under docs/.

3.3 KiB Raw Blame History

Documentation layout (docs/)