mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
refactor: update project branding and structure for gregFramework
- 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 quality.
This commit is contained in:
Marvin
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: Assets & export
|
||||
sidebar_label: Assets & export (hub)
|
||||
description: Asset export plugin, templates, and related wiki-import pages.
|
||||
description: Asset export plugin, templates, and related legacy wiki-import pages.
|
||||
---
|
||||
|
||||
# Assets & export
|
||||
|
||||
- Wiki: [FFM.Plugin.AssetExporter](/wiki/mods/extensions/ffm-plugin-asset-exporter)
|
||||
- Wiki: [FFM.Plugin.AssetExporter](/wiki/plugins/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)
|
||||
- Imported: [AssetExport](/wiki/legacy/wiki-import/AssetExport), [Release assets and templates](/wiki/legacy/wiki-import/Release-Assets-and-Templates)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
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).
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
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).
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
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)
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
title: Topics hub
|
||||
sidebar_label: Topics overview
|
||||
description: Thematic index — navigate by audience, reference, roadmap, imports, and meta.
|
||||
description: Thematic index — cross-cutting overviews (assets, multiplayer, security, FFI, 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/`).
|
||||
Documentation combines **curated pages** (guides, framework, reference), **generated reference** (hook catalogs), and **legacy imports** from the GitHub wiki (`.wiki` → `docs/legacy/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) |
|
||||
| **Roles** | [By audience](/wiki/guides/players/audiences-overview) — [End users](/wiki/guides/players/overview), [Mod developers](/wiki/guides/mod-developers/overview), [Contributors (workflow)](/wiki/guides/contributors/topics-overview), [Sponsors](/wiki/guides/sponsors/overview) |
|
||||
| **Experience paths** | [Newbies](/wiki/guides/players/newbies) · [Intermediates](/wiki/guides/players/intermediates) · [Professionals](/wiki/guides/players/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) |
|
||||
@@ -22,16 +22,14 @@ Documentation is split into **curated wiki pages** (this site), **generated refe
|
||||
|
||||
## 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.
|
||||
- [Security & legal](/wiki/topics/security-legal/overview)
|
||||
- [FFI, hooks & Lua](/wiki/topics/ffi-and-hooks/overview)
|
||||
- [Multiplayer & networking](/wiki/topics/multiplayer-and-networking/overview)
|
||||
- [Assets & export](/wiki/topics/assets-and-export/overview)
|
||||
- [End users](/wiki/guides/players/overview)
|
||||
- [Mod developers](/wiki/guides/mod-developers/overview)
|
||||
|
||||
## 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).
|
||||
- **Release pages:** [Releases](/wiki/releases/)
|
||||
- **Narrative articles:** [Plugins](/wiki/plugins/) and [Mods](/wiki/mods/)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
---
|
||||
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)
|
||||
@@ -6,7 +6,7 @@ description: P2P roadmap, Web UI bridge, multiplayer plugin — entry points.
|
||||
|
||||
# Multiplayer & networking
|
||||
|
||||
- Wiki: [FFM.Plugin.Multiplayer](/wiki/mods/extensions/ffm-plugin-multiplayer)
|
||||
- Wiki: [FFM.Plugin.Multiplayer](/wiki/plugins/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)
|
||||
- Imported: [Steamworks P2P multiplayer roadmap](/wiki/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap)
|
||||
- Imported: [Web UI bridge](/wiki/legacy/wiki-import/Web-UI-Bridge)
|
||||
|
||||
@@ -10,6 +10,7 @@ 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.
|
||||
- [Modding language (C# only)](/wiki/reference/modding-language-requirement) — mods, plugins, extensions: **C#** only.
|
||||
- [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.
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
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).
|
||||
:::
|
||||
@@ -1,52 +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.
|
||||
description: How GitHub Wiki content is mirrored into docs/legacy/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).
|
||||
All material under **`docs/legacy/wiki-import/`** is part of the **GitHub Wiki mirror**: it tracks the wiki that lives alongside the repository, while the rest of **`docs/`** holds **curated** pages (guides, framework, reference).
|
||||
|
||||
For a **map of the whole `docs/` tree**, see **[Documentation layout (`docs/`)](../../README.md)**.
|
||||
For a **map of the whole `docs/` tree**, see **[Documentation layout](../../getting-started/documentation-layout.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/...`.
|
||||
- **i18n**: Paired `Page.md` (DE) + `Page-en.md` (EN) are split by `wiki:normalize-i18n` into the default locale and `i18n/de/.../legacy/wiki-import/`.
|
||||
- **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/`):
|
||||
1. Clone or pull the wiki repo into **`.wiki/`** at **`gregFramework/`** (sibling to your repo clones):
|
||||
|
||||
```bash
|
||||
git clone https://github.com/<org>/<repo>.wiki.git .wiki
|
||||
```
|
||||
|
||||
2. From **`wiki/`** (the Docusaurus app):
|
||||
2. From **`gregWiki/`** (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.
|
||||
This runs **`wiki:sync`** (copy `.wiki` → `docs/legacy/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.
|
||||
3. Commit changes under **`docs/legacy/wiki-import/`** and **`i18n/de/.../legacy/wiki-import/`** 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. |
|
||||
| **Short-term fix** on the live site | Edit files under `docs/legacy/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/guides/`**, **`docs/reference/`**, or **`docs/framework/`**, 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)
|
||||
- [Home](/wiki/legacy/wiki-import/Home) — audience hub.
|
||||
- [End users](/wiki/legacy/wiki-import/EndUser/) · [Mod developers](/wiki/legacy/wiki-import/ModDevs/) · [Contributors](/wiki/legacy/wiki-import/Contributors/)
|
||||
- [Technical reference](/wiki/legacy/wiki-import/TechnicalReference/) · [Data Center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/)
|
||||
- [HOOKS](/wiki/legacy/wiki-import/HOOKS) · [FFI bridge reference](/wiki/legacy/wiki-import/FFI-Bridge-Reference)
|
||||
|
||||
The sidebar **Topics → Legacy wiki import** lists the **full** tree (autogenerated), not only these links.
|
||||
The sidebar **Legacy** lists the **full** tree (autogenerated), not only these links.
|
||||
|
||||
Reference in New Issue
Block a user