mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
3b245ee966
- 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.
37 lines
3.3 KiB
Markdown
37 lines
3.3 KiB
Markdown
# 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`](/wiki/docs) | Site home (`/wiki/docs`). |
|
|
| **Topics hub** | [`topics/`](./topics/index.md) | Cross-cutting overviews (security, FFI, multiplayer, assets, meta). |
|
|
| **Mods & plugins** | [`mods/`](./mods/), [`plugins/`](./plugins/) | Gameplay mods (`FMF.*`) and framework plugins (`FFM.Plugin.*`). |
|
|
| **Releases** | [`releases/`](./releases/) | Per-artifact release notes. |
|
|
| **Reference** | [`reference/`](./reference/) | Hooks, naming, MCP, generated catalogs. |
|
|
| **Contributors** | [`contributors/`](./contributors/) | Repo layout, Docusaurus workflow, design system. |
|
|
| **Guides** | [`guides/`](./guides/players/overview.md) | Role-based paths (players, mod developers, contributors, sponsors). |
|
|
| **Roadmap** | [`roadmap/`](./roadmap/) | Planning docs. |
|
|
| **Meta** | [`meta/`](./meta/) | Workshop, devserver, backlog; [architecture principles](./meta/system-architecture-principles.md) (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/`.
|