mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
c46717b3cf
- Changed project title and tagline in docusaurus.config.js to reflect the new branding. - Updated package.json and package-lock.json to rename the project to gregwiki-docs-site. - Adjusted sidebar and documentation files to align with the new project structure and naming conventions. - Enhanced documentation content for clarity and consistency across various sections. - Added Prettier as a development dependency for code formatting. This commit aligns the project with the new branding and improves overall documentation structure.
53 lines
4.0 KiB
Markdown
53 lines
4.0 KiB
Markdown
# Documentation layout (`docs/`)
|
|
|
|
This folder is the **single source of truth** for the public Docusaurus site. The Docusaurus app lives in the **repository root** next to `docs/`; built pages are served under the **`/wiki`** base path.
|
|
|
|
## How content is organized
|
|
|
|
| Area | Path | Purpose |
|
|
|------|------|--------|
|
|
| **Landing** | [`intro.md`](./intro.md) | Site home (`/wiki/docs`). |
|
|
| **Curated topics** | [`topics/`](./topics/) | Hubs: **Rollen** (Spieler, Moddevs, Contributor, Sponsoren → [`audiences/overview`](./topics/audiences/overview.md)), Roadmap, Security, Wiki-Import. |
|
|
| **Mods & plugins** | [`mods/`](./mods/) | Framework, plugin wiki, mod wiki, standalone index. |
|
|
| **Releases** | [`releases/`](./releases/) | Per-artifact release notes. |
|
|
| **Reference** | [`reference/`](./reference/) | Hooks, naming, MCP, generated catalogs. |
|
|
| **Contributors** | [`contributors/`](./contributors/) | Repo layout, Docusaurus workflow, design system. |
|
|
| **Audiences** | [`audiences/`](./audiences/) | Newbies / intermediates / professionals. |
|
|
| **Roadmap** | [`roadmap/`](./roadmap/) | Planning docs. |
|
|
| **Meta** | [`meta/`](./meta/) | Workshop, devserver, backlog. |
|
|
| **Monorepo wiki stubs** | [`wiki/`](./wiki/) | Short pages tied to the target repo layout (e.g. Hexmod). **Not** the GitHub Wiki import. |
|
|
| **Legacy GitHub Wiki import** | [`wiki-import/`](./wiki-import/) | Bulk import from `.wiki/` (see below). |
|
|
|
|
## Legacy GitHub Wiki (`docs/wiki-import/`)
|
|
|
|
Long-form pages that originally lived in the **GitHub Wiki** are mirrored here so they are searchable and versioned with the repo.
|
|
|
|
1. **Clone or update** the wiki working tree next to this repo as **`../.wiki/`** under the parent `gregFramework/` folder (separate clone: `https://github.com/<org>/<repo>.wiki.git`), or set up the same path the sync script expects.
|
|
2. From the **gregWiki repository root**, refresh the mirror and split locales:
|
|
- `npm run wiki:refresh`
|
|
- Or stepwise: `npm run wiki:sync` → `npm run wiki:normalize-i18n` (optional `--dry-run` first).
|
|
3. **German** translations for paired pages live under `i18n/de/docusaurus-plugin-content-docs/current/wiki-import/` after normalization.
|
|
4. **New curated docs** should usually be added as normal Markdown under `docs/` (topics, reference, mods), not only under `wiki-import/`, so they stay easy to find. Use `wiki-import/` for bulk legacy material and incremental fixes; migrate important pages into `docs/topics/` or `docs/reference/` when you rewrite them.
|
|
|
|
Details: [`topics/wiki-import/overview.md`](./topics/wiki-import/overview.md).
|
|
|
|
## URLs
|
|
|
|
- Doc id `intro` → `/wiki/docs` (see front matter).
|
|
- Most docs → `/wiki/<doc-path>` (e.g. `mods/framework` → `/wiki/mods/framework`).
|
|
- The monorepo stub folder uses ids like `wiki/mods/hexmod` → `/wiki/wiki/mods/hexmod` (double `wiki` in the path). Prefer linking by **doc id** or stable titles rather than hand-typing URLs.
|
|
|
|
## Scripts (repository root)
|
|
|
|
| Script | Location | Role |
|
|
|--------|------------|------|
|
|
| Sync `../.wiki` → `docs/wiki-import/` | `scripts/sync-wiki-to-docs.mjs` | Copies `*.md` from the sibling `.wiki/` clone under `gregFramework/`. |
|
|
| Split DE/EN pairs | `scripts/normalize-wiki-import-i18n.mjs` | EN default locale, DE under `i18n/de/...`. |
|
|
| Sidebar category keys | `scripts/write-wiki-import-category-keys.mjs` | Regenerates `_category_.json` keys under Guides/Reference/Troubleshooting (if present). |
|
|
|
|
## Locales (EN / DE / others)
|
|
|
|
- **Default locale:** `en` — curated pages live under `docs/` (e.g. `intro.md`, `getting-started.md`).
|
|
- **German:** override files under `i18n/de/docusaurus-plugin-content-docs/current/` with the **same path** as in `docs/` (same doc `id` / filename). Example: `intro.md` and `getting-started.md` are fully maintained in DE.
|
|
- **fr, es, ru, ja:** enabled in `docusaurus.config.js`; where no translated file exists, Docusaurus **falls back** to the English `docs/` markdown. Add more translated files under `i18n/<locale>/docusaurus-plugin-content-docs/current/` as needed.
|