From 1d4676f52b3561a96510a216efcd605b116f6829 Mon Sep 17 00:00:00 2001 From: Marvin <52848568+mleem97@users.noreply.github.com> Date: Thu, 9 Apr 2026 23:59:32 +0200 Subject: [PATCH] fix(docs): extension-less links for DE locale; format README and custom.css Made-with: Cursor --- docs/README.md | 38 +++++++++---------- docs/contributors/repo-inventory.md | 10 ++--- .../current/getting-started.md | 2 +- .../current/intro.md | 20 +++++----- src/css/custom.css | 6 ++- 5 files changed, 40 insertions(+), 36 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8554ae1..b1e2fb7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,19 +4,19 @@ This folder is the **single source of truth** for the public Docusaurus site. Th ## 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). | +| Area | Path | Purpose | +| ----------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Landing** | [`intro` → `/wiki/docs`](/wiki/docs) | 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/`) @@ -24,7 +24,7 @@ Long-form pages that originally lived in the **GitHub Wiki** are mirrored here s 1. **Clone or update** the wiki working tree next to this repo as **`../.wiki/`** under the parent `gregFramework/` folder (separate clone: `https://github.com//.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` + - `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. @@ -39,11 +39,11 @@ Details: [`topics/wiki-import/overview.md`](./topics/wiki-import/overview.md). ## 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). | +| 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) diff --git a/docs/contributors/repo-inventory.md b/docs/contributors/repo-inventory.md index 0e41847..774bb28 100644 --- a/docs/contributors/repo-inventory.md +++ b/docs/contributors/repo-inventory.md @@ -11,7 +11,7 @@ This page is the **source of truth snapshot** for how the **gregFramework worksp ## Top-level workspace (`gregFramework/`) -These folders typically sit **next to each other** in a developer workspace (see also [intro](../intro.md)): +These folders typically sit **next to each other** in a developer workspace (see also [intro](/wiki/docs)): | Area | Path (on disk) | Role | |------|----------------|------| @@ -61,7 +61,7 @@ Paths below are relative to **`gregCore/FrikaMF-StandaloneRepo/`** (standalone f ## Documentation (Docusaurus) -- **Entry**: `/wiki` → [`intro`](../intro.md) +- **Entry**: `/wiki` → [`intro`](/wiki/docs) - **Sidebar**: [`sidebars.js`](https://github.com/mleem97/gregWiki/blob/main/sidebars.js) - **Module catalog** (downloads table): [`src/data/moduleCatalog.ts`](https://github.com/mleem97/gregWiki/blob/main/src/data/moduleCatalog.ts) - **Landing**: `/` → [`src/pages/index.tsx`](https://github.com/mleem97/gregWiki/blob/main/src/pages/index.tsx) @@ -81,6 +81,6 @@ Paths below are relative to **`gregCore/FrikaMF-StandaloneRepo/`** (standalone f ## Related -- [Monorepo target layout](./monorepo-target-layout.md) — phased folder goals -- [FMF hook naming](../reference/fmf-hook-naming.md) — naming convention -- [Release channels](../reference/release-channels.md) — Steam vs GitHub beta +- [Monorepo target layout](/wiki/contributors/monorepo-target-layout) — phased folder goals +- [FMF hook naming](/wiki/reference/fmf-hook-naming) — naming convention +- [Release channels](/wiki/reference/release-channels) — Steam vs GitHub beta diff --git a/i18n/de/docusaurus-plugin-content-docs/current/getting-started.md b/i18n/de/docusaurus-plugin-content-docs/current/getting-started.md index 9405d66..26987cc 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/getting-started.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/getting-started.md @@ -46,4 +46,4 @@ Im `gregWiki`-Root: `docker build -t gregwiki-docs .` und `docker run --rm -p 30 ### MCP -Siehe [`reference/mcp-server`](./reference/mcp-server.md) im Core (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`). +Siehe [`reference/mcp-server`](/wiki/reference/mcp-server) im Core (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`). diff --git a/i18n/de/docusaurus-plugin-content-docs/current/intro.md b/i18n/de/docusaurus-plugin-content-docs/current/intro.md index 1cadcac..220be66 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/intro.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/intro.md @@ -11,12 +11,12 @@ Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` a | Zielgruppe | Einstieg | |------------|----------| -| **Spieler** — installieren, spielen, Troubleshooting | [Endnutzer (Hub)](./topics/end-user/overview.md) · [Endnutzer-Wiki (Import)](./wiki-import/EndUser/) | -| **Moddevs** — Mods bauen, Hooks, Debugging | [Mod-Entwickler (Hub)](./topics/mod-developers/overview.md) · [ModDevs-Wiki (Import)](./wiki-import/ModDevs/) · [Framework](./mods/framework.md) | -| **Contributor** — PRs, Doku, Plugins, CI | [Contributors (Workflow)](./topics/contributors/overview.md) · [Contributors-Wiki (Import)](./wiki-import/Contributors/) | -| **Sponsorinnen & Sponsoren** | [Sponsors (Hub)](./topics/sponsors/overview.md) · [Sponsors (EN)](./wiki-import/Sponsors) · [Sponsoren (DE)](./wiki-import/Sponsoren) | +| **Spieler** — installieren, spielen, Troubleshooting | [Endnutzer (Hub)](/wiki/topics/end-user/overview) · [Endnutzer-Wiki (Import)](/wiki/wiki-import/EndUser/) | +| **Moddevs** — Mods bauen, Hooks, Debugging | [Mod-Entwickler (Hub)](/wiki/topics/mod-developers/overview) · [ModDevs-Wiki (Import)](/wiki/wiki-import/ModDevs/) · [Framework](/wiki/mods/framework) | +| **Contributor** — PRs, Doku, Plugins, CI | [Contributors (Workflow)](/wiki/topics/contributors/overview) · [Contributors-Wiki (Import)](/wiki/wiki-import/Contributors/) | +| **Sponsorinnen & Sponsoren** | [Sponsors (Hub)](/wiki/topics/sponsors/overview) · [Sponsors (EN)](/wiki/wiki-import/Sponsors) · [Sponsoren (DE)](/wiki/wiki-import/Sponsoren) | -**Erfahrungspfade** (Einsteiger → Profis): [Nach Zielgruppe](./topics/audiences/overview.md) → [Newbies](./audiences/newbies.md), [Intermediates](./audiences/intermediates.md), [Professionals](./audiences/professionals.md). +**Erfahrungspfade** (Einsteiger → Profis): [Nach Zielgruppe](/wiki/topics/audiences/overview) → [Newbies](/wiki/audiences/newbies), [Intermediates](/wiki/audiences/intermediates), [Professionals](/wiki/audiences/professionals). ## Repository-Hub @@ -27,14 +27,14 @@ Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` a ## Hooks und Releases -- [FMF Hook-Naming](./reference/fmf-hook-naming.md) — `FMF..…` und Legacy `FFM.*` -- [FMF-Hooks-Katalog](./reference/fmf-hooks-catalog.md) — generiert aus Core-`HookNames.cs` -- [Release-Kanäle](./reference/release-channels.md) — Steam Workshop vs GitHub (Beta) -- [MCP-Server](./reference/mcp-server.md) — optionale LLM/IDE-Tools über Doku + `fmf_hooks.json` +- [FMF Hook-Naming](/wiki/reference/fmf-hook-naming) — `FMF..…` und Legacy `FFM.*` +- [FMF-Hooks-Katalog](/wiki/reference/fmf-hooks-catalog) — generiert aus Core-`HookNames.cs` +- [Release-Kanäle](/wiki/reference/release-channels) — Steam Workshop vs GitHub (Beta) +- [MCP-Server](/wiki/reference/mcp-server) — optionale LLM/IDE-Tools über Doku + `fmf_hooks.json` ## Layout (Contributors) -- [Repo-Inventar](./contributors/repo-inventory.md) — Projekt- und Repo-Übersicht +- [Repo-Inventar](/wiki/contributors/repo-inventory) — Projekt- und Repo-Übersicht - Split-Konvention: `gregMod.`, `gregExt.`, `gregSta.` ## Quellenmodell diff --git a/src/css/custom.css b/src/css/custom.css index f0fed1a..1e74b51 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -423,7 +423,11 @@ body { /* Doc canvas — editorial bleed (wiki layout alignment); no hard section borders */ .theme-doc-wrapper { - background: linear-gradient(180deg, var(--color-surface-container-low) 0%, var(--color-background) 42%); + background: linear-gradient( + 180deg, + var(--color-surface-container-low) 0%, + var(--color-background) 42% + ); } .theme-doc-root .theme-doc-sidebar-container {