mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
Merge Docusaurus site: all content under docs/, align with gregFramework split layout
- Move markdown and wiki-import tree into docs/; keep app shell at repo root - Point docusaurus docs path to docs/; edit links to mleem97/gregWiki - Sync and i18n scripts use gregWiki root and ../.wiki under gregFramework - Sidebars: workspace layout from root docs ids; plugins under mods/extensions - Fix redirects, module catalog URLs, release note paths, and wiki-import category keys - Update repo inventory for split repos; Dockerfile for single-repo context Made-with: Cursor
This commit is contained in:
11
docs/topics/assets-and-export/overview.md
Normal file
11
docs/topics/assets-and-export/overview.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Assets & export
|
||||
sidebar_label: Assets & export (hub)
|
||||
description: Asset export plugin, templates, and related wiki-import pages.
|
||||
---
|
||||
|
||||
# Assets & export
|
||||
|
||||
- Wiki: [FFM.Plugin.AssetExporter](/wiki/mods/extensions/ffm-plugin-asset-exporter)
|
||||
- Release: [FFM.Plugin.AssetExporter release](/wiki/releases/plugins/ffm-plugin-asset-exporter-release)
|
||||
- Imported: [AssetExport](/wiki/wiki-import/AssetExport), [Release assets and templates](/wiki/wiki-import/Release-Assets-and-Templates)
|
||||
29
docs/topics/audiences/overview.md
Normal file
29
docs/topics/audiences/overview.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: By audience
|
||||
sidebar_label: By audience
|
||||
description: Vier Rollen — Spieler, Moddevs, Contributor, Sponsoren — plus Erfahrungsstufen (Newbies bis Pros).
|
||||
---
|
||||
|
||||
# By audience
|
||||
|
||||
Die Dokumentation richtet sich an **vier Hauptrollen** (und an Erfahrungsstufen darunter). Wähle, was zu dir passt — die Sprache der meisten Seiten ist **Englisch**, mit deutschsprachigen Importen unter `wiki-import/` wo vorhanden.
|
||||
|
||||
## Die vier Rollen
|
||||
|
||||
| Rolle | Für wen? | Einstieg |
|
||||
|--------|----------|----------|
|
||||
| **Spieler** (End users) | Installation, Mods nutzen, Troubleshooting, FAQ | [End users (hub)](/wiki/topics/end-user/overview) → [End user wiki](/wiki/wiki-import/EndUser/), [Data center FAQ](/wiki/wiki-import/DataCenterFAQ/) |
|
||||
| **Mod-Entwickler** (Mod developers) | Mods bauen, Hooks, Konfiguration, Debug | [Mod developers (hub)](/wiki/topics/mod-developers/overview) → [ModDevs wiki](/wiki/wiki-import/ModDevs/), [Framework](/wiki/mods/framework) |
|
||||
| **Contributor** (Repo & Framework) | PRs, Doku, Plugins, CI, Design | [Contributors (workflow)](/wiki/topics/contributors/overview) → [Contributors wiki](/wiki/wiki-import/Contributors/), [Repo inventory](/wiki/contributors/repo-inventory) |
|
||||
| **Sponsorinnen & Sponsoren** | Unterstützung, Transparenz, rechtlicher Kontext | [Sponsors (hub)](/wiki/topics/sponsors/overview) → [Sponsors (EN)](/wiki/wiki-import/Sponsors), [Sponsoren (DE)](/wiki/wiki-import/Sponsoren) |
|
||||
|
||||
## Erfahrungsstufen (alle Rollen)
|
||||
|
||||
- [Newbies](/wiki/audiences/newbies) — erste Schritte, Begriffe, sichere Defaults.
|
||||
- [Intermediates](/wiki/audiences/intermediates) — Workflows, Tooling, typische Stolpersteine.
|
||||
- [Professionals](/wiki/audiences/professionals) — Architektur, FFI, Performance, Release-Kanäle.
|
||||
|
||||
## Thematische Übersicht
|
||||
|
||||
- [Topics hub](/wiki/topics/) — Security, Multiplayer, Assets, FFI, Roadmap, Meta.
|
||||
- Importierte Legacy-Guides: [Legacy wiki import](/wiki/topics/wiki-import/overview).
|
||||
19
docs/topics/contributors/overview.md
Normal file
19
docs/topics/contributors/overview.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Contributors (workflow)
|
||||
sidebar_label: Contributors (workflow)
|
||||
description: Monorepo layout, design system, Docusaurus workflow, plugin audits.
|
||||
---
|
||||
|
||||
# Contributors (workflow)
|
||||
|
||||
**Mitwirkende am Repository** — Framework, Website, CI, Plugins. Überblick über alle Rollen (inkl. Spieler, Moddevs, Sponsoren): [By audience](/wiki/topics/audiences/overview).
|
||||
|
||||
Operational docs for people changing the framework, site, or release pipeline.
|
||||
|
||||
- [Repository inventory](/wiki/contributors/repo-inventory) — current layout snapshot.
|
||||
- [Monorepo target layout](/wiki/contributors/monorepo-target-layout) — intended structure.
|
||||
- [Luminescent design system](/wiki/contributors/luminescent-design-system) — UI tokens for the site.
|
||||
- [Docusaurus workflow](/wiki/contributors/docusaurus-workflow) — edit/build the wiki site.
|
||||
- [Plugin submission audit](/wiki/contributors/plugin-submission-audit) — checklist for new plugins.
|
||||
|
||||
Imported guides: [Contribution workflow](/wiki/wiki-import/Contributors/Guides/Contribution-Workflow).
|
||||
13
docs/topics/end-user/overview.md
Normal file
13
docs/topics/end-user/overview.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: End users
|
||||
sidebar_label: End users (hub)
|
||||
description: FAQs, install paths, troubleshooting — mostly wiki-import.
|
||||
---
|
||||
|
||||
# End users
|
||||
|
||||
**Spielerinnen und Spieler** — Mods installieren und spielen, ohne am Framework mitzuentwickeln. Überblick über alle Rollen: [By audience](/wiki/topics/audiences/overview).
|
||||
|
||||
- [By audience — newbies](/wiki/audiences/newbies)
|
||||
- Imported: [End user index](/wiki/wiki-import/EndUser/), [Data center FAQ](/wiki/wiki-import/DataCenterFAQ/), [Known incompatibilities](/wiki/wiki-import/Known-Incompatibilities)
|
||||
- Imported: [End user release notes](/wiki/wiki-import/EndUser/End-User-Release)
|
||||
13
docs/topics/ffi-and-hooks/overview.md
Normal file
13
docs/topics/ffi-and-hooks/overview.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: FFI, hooks & Lua
|
||||
sidebar_label: FFI, hooks & Lua (hub)
|
||||
description: FFI, hook lists, naming — bridge between framework and legacy wiki.
|
||||
---
|
||||
|
||||
# FFI, hooks & Lua
|
||||
|
||||
- [FMF hooks catalog](/wiki/reference/fmf-hooks-catalog) (generated)
|
||||
- [FMF hook naming](/wiki/reference/fmf-hook-naming)
|
||||
- Imported: [HOOKS](/wiki/wiki-import/HOOKS), [Hook naming convention](/wiki/wiki-import/HOOK-NAMING-CONVENTION)
|
||||
- Imported: [FFI bridge reference](/wiki/wiki-import/FFI-Bridge-Reference), [Lua FFI start](/wiki/wiki-import/Lua-FFI-Start-Developing)
|
||||
- Imported: [Mod developer debug](/wiki/wiki-import/Mod-Developer-Debug)
|
||||
37
docs/topics/index.md
Normal file
37
docs/topics/index.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: Topics hub
|
||||
sidebar_label: Topics overview
|
||||
description: Thematic index — navigate by audience, reference, roadmap, imports, and meta.
|
||||
---
|
||||
|
||||
# Topics hub
|
||||
|
||||
Documentation is split into **curated wiki pages** (this site), **generated reference** (for example hook catalogs), and **legacy imports** from the GitHub wiki (`.wiki` → `wiki-import/`).
|
||||
|
||||
## Quick map
|
||||
|
||||
| Area | Start here |
|
||||
|------|------------|
|
||||
| **Roles (Spieler · Moddevs · Contributor · Sponsoren)** | [By audience](/wiki/topics/audiences/overview) — [End users](/wiki/topics/end-user/overview), [Mod developers](/wiki/topics/mod-developers/overview), [Contributors (workflow)](/wiki/topics/contributors/overview), [Sponsors](/wiki/topics/sponsors/overview) |
|
||||
| **Audience paths (experience)** | [Newbies](/wiki/audiences/newbies) · [Intermediates](/wiki/audiences/intermediates) · [Professionals](/wiki/audiences/professionals) |
|
||||
| **Technical reference** | [Reference & technical](/wiki/topics/reference/overview) |
|
||||
| **Ship planning** | [Roadmap & planning](/wiki/topics/roadmap/overview) |
|
||||
| **Repository inventory** | [Repo inventory](/wiki/contributors/repo-inventory) |
|
||||
| **Imported legacy wiki** | [Legacy wiki import](/wiki/topics/wiki-import/overview) |
|
||||
| **Steam, betas, backlog, game paths** | [Meta & operations](/wiki/topics/meta/overview) — [Game folder layout](/wiki/topics/meta/game-folder-layout) |
|
||||
|
||||
## Thematic folders (deep links)
|
||||
|
||||
Use these entry points for cross-cutting concerns; each page links into `wiki-import/` and reference docs where relevant.
|
||||
|
||||
- [Security & legal](/wiki/topics/security-legal/overview) — licenses, disclaimers, letters to the developer.
|
||||
- [FFI, hooks & Lua](/wiki/topics/ffi-and-hooks/overview) — HOOKS, FFI bridge, naming conventions.
|
||||
- [Multiplayer & networking](/wiki/topics/multiplayer-and-networking/overview) — Steamworks P2P, Web UI bridge.
|
||||
- [Assets & export](/wiki/topics/assets-and-export/overview) — asset export pipeline, templates.
|
||||
- [End users](/wiki/topics/end-user/overview) — installs, FAQs, troubleshooting.
|
||||
- [Mod developers](/wiki/topics/mod-developers/overview) — getting started, mod config, debugging.
|
||||
|
||||
## Releases vs. articles
|
||||
|
||||
- **Release pages** (downloads, version banners): [Releases](/wiki/releases/).
|
||||
- **Narrative wiki articles** (how it works): [Plugin Wiki](/wiki/mods/extensions) and [Mod Wiki](/wiki/mods/mods).
|
||||
62
docs/topics/meta/game-folder-layout.md
Normal file
62
docs/topics/meta/game-folder-layout.md
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Game folder layout (FMF / MelonLoader)
|
||||
sidebar_label: Game folder layout
|
||||
description: Canonical paths for mod configs, FMF plugins, and MelonLoader mods under the Data Center game root.
|
||||
---
|
||||
|
||||
# Game folder layout (FMF / MelonLoader)
|
||||
|
||||
This page is the **single reference** for where mod-related files live next to the game executable (`{GameRoot}`). MelonLoader sets `{GameRoot}/UserData` via `MelonEnvironment.UserDataDirectory`, `{GameRoot}/Mods` for **MelonMods**, and `{GameRoot}/Plugins` for **MelonPlugins** (e.g. `FMF.ModPathRedirector.dll`).
|
||||
|
||||
## Summary
|
||||
|
||||
| Inhalt | Pfad | Format / Hinweis |
|
||||
|--------|------|------------------|
|
||||
| **Mod-Konfiguration & Sidecars** | `{GameRoot}/UserData/ModCfg/` | **JSON** für Konfigurationsdateien; weitere Sidecar-Dateien (z. B. `custom_employees_hired.txt`) liegen ebenfalls hier, damit alles Mod-Bezogene an einem Ort liegt. |
|
||||
| **FMF Framework-Plugins** (FFM.Plugin.*) | `{GameRoot}/FMF/Plugins/` | DLLs; **MelonLoader** lädt standardmäßig nur `{GameRoot}/Mods` — siehe unten. |
|
||||
| **Plugins** (MelonLoader, z. B. ModPathRedirector) | `{GameRoot}/Plugins/` | MelonLoader `Plugins`-Ordner — nur **MelonPlugin**-DLLs. |
|
||||
| **Mods** (MelonLoader, z. B. FMF.Mod.*) | `{GameRoot}/Mods/` | MelonLoader `Mods`-Ordner — **MelonMod**-DLLs. |
|
||||
|
||||
## UserData/ModCfg
|
||||
|
||||
- Alle **mod-relevanten** Konfigurationen und JSON-Sidecars werden unter **`UserData/ModCfg`** geführt.
|
||||
- Beim ersten Start werden fehlende Dateien angelegt; bei bestehenden Installationen werden ältere Dateien aus **`UserData/`** (Root) nach **`ModCfg/`** übernommen, sofern noch vorhanden.
|
||||
- Beispiele: `multiplayer-sync.config.json`, `pluginsync.config.json`.
|
||||
- Framework-Metadaten (z. B. Save-Compat-Stamp) liegen unter **`UserData/ModCfg/FrikaFM/`** (Migration von `UserData/FrikaFM`).
|
||||
|
||||
## FMF/Plugins und MelonLoader
|
||||
|
||||
**FFM-Plugin-DLLs** liegen kanonisch unter **`{GameRoot}/FMF/Plugins`**. MelonLoader enumeriert **standardmäßig** nur **`Mods/`**. Praktische Optionen:
|
||||
|
||||
1. **DLLs zusätzlich** (oder verlinkt) **`Mods/`** ablegen — üblicher Weg für automatisches Laden.
|
||||
2. **Unterordner** von `Mods` nutzen, falls eure MelonLoader-Version Mods in Unterverzeichnissen lädt (Version je nach Release prüfen).
|
||||
3. **PluginSync**-Downloads des Frameworks landen unter **`FMF/Plugins/PluginSync/...`**.
|
||||
|
||||
## Mods (FMF-basiert)
|
||||
|
||||
Normale **MelonLoader-Mods** (einschließlich FMF-Mods) werden wie gewohnt in **`{GameRoot}/Mods/`** installiert.
|
||||
|
||||
## Steam Workshop (Spiel) vs. MelonLoader
|
||||
|
||||
Das Spiel legt abonnierte Workshop-Inhalte unter **`{GameRoot}/{ExeName}_Data/StreamingAssets/mods/workshop_<PublishedFileId>/WorkshopUploadContent`** ab (nativer `ModLoader`, nicht MelonLoader).
|
||||
|
||||
- **MelonLoader** durchsucht **`{GameRoot}/Mods`** (inkl. Unterordner, je nach Einstellung), **nicht** beliebige Pfade über `Loader.cfg`.
|
||||
- **UserData:** MelonLoader-Konfiguration liegt unter **`{GameRoot}/UserData/`** (z. B. **`MelonLoader.cfg`** / je nach Version **`UserData/MelonLoader/Loader.cfg`** — bei Install prüfen). Relevant für Unterordner-Laden: **`disable_subfolder_load = false`**, optional **`disable_subfolder_manifest = true`**.
|
||||
- **Workshop-DLLs in den Melon-Scan einbinden:** Junction (oder Symlink) von einem Ordner unter **`Mods/`** auf den **`WorkshopUploadContent`**-Pfad desselben Items, z. B. (PowerShell, Pfade anpassen):
|
||||
|
||||
```powershell
|
||||
$game = "C:\Path\To\Data Center"
|
||||
$id = "12345678901234567"
|
||||
$target = Join-Path $game "Data Center_Data\StreamingAssets\mods\workshop_$id\WorkshopUploadContent"
|
||||
$link = Join-Path $game "Mods\workshop_$id"
|
||||
cmd /c mklink /J "$link" "$target"
|
||||
```
|
||||
|
||||
Ohne Junction müssen MelonMods weiter physisch unter **`Mods/`** liegen oder über eure Verteilung dort landen.
|
||||
|
||||
**WorkshopUploader-Vorlagen (modded):** Unter **`content/`** werden **`Mods/`**, **`Plugins/`** und ein **`ModFramework/`**-Baum angelegt — **`ModFramework/FMF/Plugins`** entspricht dabei **`{GameRoot}/FMF/Plugins`**, wenn ihr **`FMF`** per Junction auf **`…/WorkshopUploadContent/ModFramework/FMF`** zeigen lasst. Weitere Framework-Dateien (Konfiguration, Assets) können unter **`ModFramework/`** gebündelt werden.
|
||||
|
||||
## Siehe auch
|
||||
|
||||
- [Meta & operations](/wiki/topics/meta/overview)
|
||||
- [Legacy: Mod Config System](/wiki/wiki-import/Mod-Config-System) (API-Contract; Pfade auf **ModCfg** beziehen)
|
||||
14
docs/topics/meta/overview.md
Normal file
14
docs/topics/meta/overview.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Meta & operations
|
||||
sidebar_label: Meta & operations
|
||||
description: Workshop tooling, devserver betas, idea backlog — repo-level notes.
|
||||
---
|
||||
|
||||
# Meta & operations
|
||||
|
||||
These pages are **not** end-user game docs; they describe how we ship and plan around the project.
|
||||
|
||||
- [Game folder layout (FMF / MelonLoader)](/wiki/topics/meta/game-folder-layout) — `UserData/ModCfg`, `FMF/Plugins`, `Mods`.
|
||||
- [Steam Workshop and tooling](/wiki/meta/Steam-Workshop-and-Tooling) — uploader, references workflow.
|
||||
- [Devserver betas](/wiki/meta/devserver-betas) — beta channel notes.
|
||||
- [IDEA backlog](/wiki/meta/IDEA_BACKLOG) — unstructured idea list (also used by automation).
|
||||
14
docs/topics/mod-developers/overview.md
Normal file
14
docs/topics/mod-developers/overview.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Mod developers
|
||||
sidebar_label: Mod developers (hub)
|
||||
description: Getting started, mod config, debugging — links into wiki-import ModDevs tree.
|
||||
---
|
||||
|
||||
# Mod developers
|
||||
|
||||
**Mod-Autorinnen und -Autoren** — eigene Mods bauen (Hooks, Konfiguration, Debug). Überblick über alle Rollen: [By audience](/wiki/topics/audiences/overview).
|
||||
|
||||
- [By audience — intermediates / professionals](/wiki/audiences/intermediates) and [professionals](/wiki/audiences/professionals)
|
||||
- Wiki: [Framework overview](/wiki/mods/framework)
|
||||
- Imported: [ModDevs](/wiki/wiki-import/ModDevs/), [Modding guide](/wiki/wiki-import/Modding-Guide), [Mod config system](/wiki/wiki-import/Mod-Config-System)
|
||||
- Imported: [Standalone mods](/wiki/wiki-import/StandaloneMods)
|
||||
12
docs/topics/multiplayer-and-networking/overview.md
Normal file
12
docs/topics/multiplayer-and-networking/overview.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Multiplayer & networking
|
||||
sidebar_label: Multiplayer & networking (hub)
|
||||
description: P2P roadmap, Web UI bridge, multiplayer plugin — entry points.
|
||||
---
|
||||
|
||||
# Multiplayer & networking
|
||||
|
||||
- Wiki: [FFM.Plugin.Multiplayer](/wiki/mods/extensions/ffm-plugin-multiplayer)
|
||||
- Release: [FFM.Plugin.Multiplayer release](/wiki/releases/plugins/ffm-plugin-multiplayer-release)
|
||||
- Imported: [Steamworks P2P multiplayer roadmap](/wiki/wiki-import/Steamworks-P2P-Multiplayer-Roadmap)
|
||||
- Imported: [Web UI bridge](/wiki/wiki-import/Web-UI-Bridge)
|
||||
17
docs/topics/reference/overview.md
Normal file
17
docs/topics/reference/overview.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: Reference & technical
|
||||
sidebar_label: Reference & technical
|
||||
description: Mapping tables, hook naming, generated catalogs, release channels.
|
||||
---
|
||||
|
||||
# Reference & technical
|
||||
|
||||
Authoritative reference material for the framework and documentation site.
|
||||
|
||||
- [Wiki mapping](/wiki/reference/wiki-mapping) — how paths line up across systems.
|
||||
- [Mod store vision](/wiki/reference/mod-store-vision) — product direction notes.
|
||||
- [FMF hook naming](/wiki/reference/fmf-hook-naming) — conventions for hook identifiers.
|
||||
- [FMF hooks catalog](/wiki/reference/fmf-hooks-catalog) — generated listing from framework sources.
|
||||
- [Release channels](/wiki/reference/release-channels) — how builds are staged.
|
||||
|
||||
See also [FFI, hooks & Lua](/wiki/topics/ffi-and-hooks/overview) for imported deep dives from the legacy wiki.
|
||||
12
docs/topics/roadmap/overview.md
Normal file
12
docs/topics/roadmap/overview.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Roadmap & planning
|
||||
sidebar_label: Roadmap & planning
|
||||
description: Unified roadmap and mod-store staging notes.
|
||||
---
|
||||
|
||||
# Roadmap & planning
|
||||
|
||||
- [Unified roadmap](/wiki/roadmap/unified-roadmap) — cross-cutting priorities.
|
||||
- [Mod store stages](/wiki/roadmap/mod-store-stages) — staged rollout concepts.
|
||||
|
||||
Imported context: [ROADMAP](/wiki/wiki-import/ROADMAP), [TASKLIST](/wiki/wiki-import/TASKLIST), [Repository status](/wiki/wiki-import/Repository-Status-2026-04-04).
|
||||
16
docs/topics/security-legal/overview.md
Normal file
16
docs/topics/security-legal/overview.md
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Security & legal
|
||||
sidebar_label: Security & legal (hub)
|
||||
description: Licenses, disclaimers, developer correspondence — links into wiki-import.
|
||||
---
|
||||
|
||||
# Security & legal
|
||||
|
||||
Curated links into imported pages (canonical text may live under `wiki-import/`).
|
||||
|
||||
- [License / legal (EN)](/wiki/wiki-import/License-Legal)
|
||||
- [Lizenz / Rechtliches (DE)](/wiki/wiki-import/Lizenz-Rechtliches)
|
||||
- [Disclaimer (End user)](/wiki/wiki-import/EndUser/Reference/Disclaimer)
|
||||
- [Brief an WASEKU](/wiki/wiki-import/Brief-an-WASEKU) / [Letter to WASEKU (EN)](/wiki/wiki-import/Letter-to-WASEKU)
|
||||
|
||||
For repository licensing, see the root `LICENSE.txt` in the GitHub repo.
|
||||
24
docs/topics/sponsors/overview.md
Normal file
24
docs/topics/sponsors/overview.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Sponsors & support
|
||||
sidebar_label: Sponsors (hub)
|
||||
description: Für Unterstützerinnen und Unterstützer — Sponsoring, Transparenz, englische Detailseiten.
|
||||
---
|
||||
|
||||
# Sponsors & support
|
||||
|
||||
Die Community finanziert u. a. Infrastruktur, Tools und Zeit für Pflege der Doku und des Frameworks. Hier startest du als **potenzielle Sponsorin oder Sponsor** (oder als Spielerin, die nur informieren möchte, wohin Unterstützung fließt).
|
||||
|
||||
## Kurzüberblick
|
||||
|
||||
- **Englisch (ausführlich):** [Sponsors (EN)](/wiki/wiki-import/Sponsors) — Optionen (z. B. GitHub Sponsors), Nutzung von Mitteln, rechtlicher Kontext.
|
||||
- **Deutsch:** [Sponsoren](/wiki/wiki-import/Sponsoren) — gleiche Themen, wo vorhanden auf Deutsch.
|
||||
- **Dank:** [Community Thanks](/wiki/wiki-import/Community-Thanks) (Import), [Changelog & versions](/wiki/wiki-import/Changelog-Versions) für Release-Transparenz.
|
||||
|
||||
## Verknüpft
|
||||
|
||||
- [Security & legal](/wiki/topics/security-legal/overview) — Lizenz, Haftungsausschlüsse, Brief an die Entwickler.
|
||||
- [License & legal (EN)](/wiki/wiki-import/License-Legal) — rechtlicher Rahmen des Projekts.
|
||||
|
||||
:::note Zielgruppe
|
||||
Diese Seite richtet sich an **Sponsorinnen, Sponsoren und Fördernde**. Spielerinnen und Spieler finden den Einstieg unter [End users](/wiki/topics/end-user/overview); Mod-Autoren unter [Mod developers](/wiki/topics/mod-developers/overview); Mitwirkende am Repo unter [Contributors (workflow)](/wiki/topics/contributors/overview).
|
||||
:::
|
||||
52
docs/topics/wiki-import/overview.md
Normal file
52
docs/topics/wiki-import/overview.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Legacy wiki import
|
||||
sidebar_label: Legacy wiki import
|
||||
description: How GitHub Wiki content is mirrored into docs/wiki-import, sorted in the sidebar, and kept in sync with the repo.
|
||||
---
|
||||
|
||||
# Legacy wiki import
|
||||
|
||||
All material under **`docs/wiki-import/`** is part of the **GitHub Wiki mirror**: it is meant to track the wiki that lives alongside the repository, while the rest of **`docs/`** holds **curated** pages (topics, mods, reference).
|
||||
|
||||
For a **map of the whole `docs/` tree**, see **[Documentation layout (`docs/`)](../../README.md)**.
|
||||
|
||||
## Why this exists
|
||||
|
||||
- **Search & versioning**: Wiki text is in Git, reviewable in PRs, and indexed by the site.
|
||||
- **i18n**: Paired `Page.md` (DE) + `Page-en.md` (EN) are split by `wiki:normalize-i18n` into the default locale and `wiki/i18n/de/...`.
|
||||
- **Sorting**: Audience trees (`EndUser/`, `ModDevs/`, `Contributors/`, `TechnicalReference/`, `DataCenterFAQ/`) use `_category_.json` **positions** so the sidebar order matches intent, not only A–Z. Root **`Home`** uses `sidebar_position: 1` so it appears first among loose pages.
|
||||
|
||||
## Keep the mirror up to date
|
||||
|
||||
1. Clone or pull the wiki repo into **`.wiki/`** at the **repository root** (same level as `docs/`):
|
||||
|
||||
```bash
|
||||
git clone https://github.com/<org>/<repo>.wiki.git .wiki
|
||||
```
|
||||
|
||||
2. From **`wiki/`** (the Docusaurus app):
|
||||
|
||||
```bash
|
||||
npm run wiki:refresh
|
||||
```
|
||||
|
||||
This runs **`wiki:sync`** (copy `.wiki` → `docs/wiki-import/`) and then **`wiki:normalize-i18n`**. If `.wiki` is missing, `wiki:sync` exits with an error; run `wiki:normalize-i18n` alone only when you are fixing splits without pulling the wiki.
|
||||
|
||||
3. Commit changes under **`docs/wiki-import/`** and **`wiki/i18n/de/...`** as needed, then open a PR.
|
||||
|
||||
## Editorial policy (recommended)
|
||||
|
||||
| Goal | Action |
|
||||
|------|--------|
|
||||
| **Short-term fix** on the live site | Edit files under `docs/wiki-import/` (and DE mirror if applicable). Optionally backport to `.wiki` so the next sync does not overwrite you. |
|
||||
| **Canonical, long-term doc** | Add or move content into **`docs/topics/`**, **`docs/reference/`**, or **`docs/mods/`**, and link from the legacy page. |
|
||||
| **Duplicate path** | The folder **`Contirbutors/`** is a typo duplicate of **`Contributors/`**; prefer **`Contributors/`** for new links. |
|
||||
|
||||
## Entry points (English default locale)
|
||||
|
||||
- [Home](/wiki/wiki-import/Home) — audience hub.
|
||||
- [End users](/wiki/wiki-import/EndUser/) · [Mod developers](/wiki/wiki-import/ModDevs/) · [Contributors](/wiki/wiki-import/Contributors/)
|
||||
- [Technical reference](/wiki/wiki-import/TechnicalReference/) · [Data Center FAQ](/wiki/wiki-import/DataCenterFAQ/)
|
||||
- [HOOKS](/wiki/wiki-import/HOOKS) · [FFI bridge reference](/wiki/wiki-import/FFI-Bridge-Reference)
|
||||
|
||||
The sidebar **Topics → Legacy wiki import** lists the **full** tree (autogenerated), not only these links.
|
||||
Reference in New Issue
Block a user