mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
e818c78baa
- Revised the tagline in `docusaurus.config.js` to reflect the focus on Data Center. - Enhanced descriptions in `getting-started.md`, `intro.md`, and various mod documentation files for consistency and clarity. - Updated references to the game name, removing "Waseku" for a more streamlined presentation. - Improved the structure and readability of tables and lists throughout the documentation. This commit aims to ensure the documentation is clear, consistent, and accurately represents the project, enhancing usability for both mod developers and players.
37 lines
1.9 KiB
Markdown
37 lines
1.9 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`](/wiki) | Mod author wiki home. |
|
|
| **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 (`greg.Plugin.*` / `FFM.Plugin.*` depending on repo). |
|
|
| **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/mod-developers/overview.md) | **Players:** `/players`. Authors: 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` (see `intro.md`, `slug: /`).
|
|
- 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/`.
|