mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
docs(readme): update README for clarity and consistency
- Translated sections from German to English for better accessibility. - Enhanced the structure by clearly defining the workspace relationship and local development instructions. - Improved descriptions for Docker setup and deployment processes to ensure users understand the requirements and context. - Updated links and formatting for consistency throughout the document. This commit aims to improve the overall clarity and usability of the README documentation.
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 legacy wiki-import pages.
|
||||
description: Asset export plugin, templates, and Workshop-related flows.
|
||||
---
|
||||
|
||||
# Assets & export
|
||||
|
||||
- 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/legacy/wiki-import/AssetExport), [Release assets and templates](/wiki/legacy/wiki-import/Release-Assets-and-Templates)
|
||||
- [FFM.Plugin.AssetExporter](/wiki/plugins/ffm-plugin-asset-exporter)
|
||||
- [FFM.Plugin.AssetExporter release](/wiki/releases/plugins/ffm-plugin-asset-exporter-release)
|
||||
- [Workshop uploader](/wiki/tools/workshop-uploader) — desktop app for publishing Workshop content
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
title: FFI, hooks & Lua
|
||||
sidebar_label: FFI, hooks & Lua (hub)
|
||||
description: FFI, hook lists, naming — bridge between framework and legacy wiki.
|
||||
description: FFI, hook lists, naming — curated reference for mod and plugin authors.
|
||||
---
|
||||
|
||||
# FFI, hooks & Lua
|
||||
|
||||
- [FMF hooks catalog](/wiki/reference/fmf-hooks-catalog) (generated)
|
||||
- [FMF hook naming](/wiki/reference/fmf-hook-naming)
|
||||
- Imported: [HOOKS](/wiki/legacy/wiki-import/HOOKS), [Hook naming convention](/wiki/legacy/wiki-import/HOOK-NAMING-CONVENTION)
|
||||
- Imported: [FFI bridge reference](/wiki/legacy/wiki-import/FFI-Bridge-Reference), [Lua FFI start](/wiki/legacy/wiki-import/Lua-FFI-Start-Developing)
|
||||
- Imported: [Mod developer debug](/wiki/legacy/wiki-import/Mod-Developer-Debug)
|
||||
- [FMF hooks](/wiki/framework/fmf-hooks) — generated hook surface
|
||||
- [FMF hooks catalog](/wiki/reference/fmf-hooks-catalog) — strings from core sources
|
||||
- [FMF hook naming](/wiki/reference/fmf-hook-naming) — `FMF.*` vs legacy `FFM.*`
|
||||
- [Framework architecture](/wiki/framework/architecture) — bridges (including Rust) and runtime layout
|
||||
- [Modding language requirement](/wiki/reference/modding-language-requirement) — C# policy for mods/plugins
|
||||
|
||||
@@ -6,7 +6,7 @@ description: Thematic index — cross-cutting overviews (assets, multiplayer, se
|
||||
|
||||
# Topics hub
|
||||
|
||||
Documentation combines **curated pages** (guides, framework, reference), **generated reference** (hook catalogs), and **legacy imports** from the GitHub wiki (`.wiki` → `docs/legacy/wiki-import/`).
|
||||
Documentation is **curated** in this repository: guides, framework articles, reference data (hook catalogs), and contributor workflow — versioned with **gregFramework** and **gregWiki**.
|
||||
|
||||
## Quick map
|
||||
|
||||
@@ -17,7 +17,6 @@ Documentation combines **curated pages** (guides, framework, reference), **gener
|
||||
| **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)
|
||||
|
||||
@@ -59,4 +59,4 @@ Ohne Junction müssen MelonMods weiter physisch unter **`Mods/`** liegen oder ü
|
||||
## Siehe auch
|
||||
|
||||
- [Meta & operations](/wiki/topics/meta/overview)
|
||||
- [Legacy: Mod Config System](/wiki/legacy/wiki-import/Mod-Config-System) (API-Contract; Pfade auf **ModCfg** beziehen)
|
||||
- Mod configuration contracts are described alongside runtime docs in [Framework](/wiki/mods/framework) and core `README` in **gregFramework** (paths under **`UserData/ModCfg/`** follow the game + framework conventions above).
|
||||
|
||||
@@ -1,15 +1,11 @@
|
||||
---
|
||||
title: Multiplayer & networking
|
||||
sidebar_label: Multiplayer & networking (hub)
|
||||
description: P2P roadmap and multiplayer plugin — separate from Sysadmin / Web UI.
|
||||
description: Multiplayer plugin, releases, and related Web UI tooling.
|
||||
---
|
||||
|
||||
# Multiplayer & networking
|
||||
|
||||
This hub covers **networking and multiplayer** only. It does **not** include [FFM.Plugin.Sysadmin](/wiki/plugins/ffm-plugin-sysadmin) (UI settings / modernizer) or [FFM.Plugin.WebUIBridge](/wiki/plugins/ffm-plugin-web-ui-bridge) (DC2 web UI) — those are separate plugins.
|
||||
|
||||
- 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/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap)
|
||||
|
||||
**Related (separate topic):** [Web UI bridge](/wiki/legacy/wiki-import/Web-UI-Bridge) — documentation import for browser-based UI; not part of the multiplayer stack.
|
||||
- [FFM.Plugin.Multiplayer](/wiki/plugins/ffm-plugin-multiplayer) — documentation for the multiplayer plugin
|
||||
- [FFM.Plugin.Multiplayer release](/wiki/releases/plugins/ffm-plugin-multiplayer-release)
|
||||
- [FFM.Plugin.WebUIBridge](/wiki/plugins/ffm-plugin-web-ui-bridge) — browser-based UI bridge (separate from the core P2P stack)
|
||||
|
||||
@@ -6,7 +6,7 @@ description: Unified roadmap and mod-store staging notes.
|
||||
|
||||
# Roadmap & planning
|
||||
|
||||
- [Unified roadmap](/wiki/roadmap/unified-roadmap) — cross-cutting priorities.
|
||||
- [Unified roadmap](/wiki/roadmap/unified-roadmap) — cross-cutting priorities for gregFramework.
|
||||
- [Mod store stages](/wiki/roadmap/mod-store-stages) — staged rollout concepts.
|
||||
|
||||
Imported context: [ROADMAP](/wiki/legacy/wiki-import/ROADMAP), [TASKLIST](/wiki/legacy/wiki-import/TASKLIST), [Repository status](/wiki/legacy/wiki-import/Repository-Status-2026-04-04).
|
||||
Historical task lists and status snapshots are folded into the unified roadmap; follow GitHub issues and releases for day-to-day execution.
|
||||
|
||||
@@ -1,16 +1,15 @@
|
||||
---
|
||||
title: Security & legal
|
||||
sidebar_label: Security & legal (hub)
|
||||
description: Licenses, disclaimers, developer correspondence — links into wiki-import.
|
||||
description: Licenses, disclaimers, and where canonical legal text lives for gregFramework.
|
||||
---
|
||||
|
||||
# Security & legal
|
||||
|
||||
Curated links into imported pages (canonical text may live under `wiki-import/`).
|
||||
This wiki is a **community** documentation site. Binding license terms and policies are maintained **in the repositories**, not duplicated here as a second source of truth.
|
||||
|
||||
- [License / legal (EN)](/wiki/legacy/wiki-import/License-Legal)
|
||||
- [Lizenz / Rechtliches (DE)](/wiki/legacy/wiki-import/Lizenz-Rechtliches)
|
||||
- [Disclaimer (End user)](/wiki/legacy/wiki-import/EndUser/Reference/Disclaimer)
|
||||
- [Brief an WASEKU](/wiki/legacy/wiki-import/Brief-an-WASEKU) / [Letter to WASEKU (EN)](/wiki/legacy/wiki-import/Letter-to-WASEKU)
|
||||
- **Framework & core:** see [`LICENSE`](https://github.com/mleem97/gregFramework/blob/master/LICENSE.txt) and [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/master/CONTRIBUTING.md) in [`mleem97/gregFramework`](https://github.com/mleem97/gregFramework).
|
||||
- **This documentation site:** content is CC-BY-SA–style community material unless a file states otherwise; the wiki itself is not an official product of the game developer.
|
||||
- **Support & conduct:** use [GitHub Issues](https://github.com/mleem97/gregFramework/issues) and [Discord](https://discord.gg/greg) under the project’s community guidelines.
|
||||
|
||||
For repository licensing, see the root `LICENSE.txt` in the GitHub repo.
|
||||
For disclaimers about unofficial tooling, refer to the repository README and release notes packaged with builds.
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
---
|
||||
title: Legacy wiki import
|
||||
sidebar_label: Legacy wiki import
|
||||
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/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](../../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 `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 **`gregFramework/`** (sibling to your repo clones):
|
||||
|
||||
```bash
|
||||
git clone https://github.com/<org>/<repo>.wiki.git .wiki
|
||||
```
|
||||
|
||||
2. From **`gregWiki/`** (the Docusaurus app):
|
||||
|
||||
```bash
|
||||
npm run wiki:refresh
|
||||
```
|
||||
|
||||
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/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/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/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 **Legacy** lists the **full** tree (autogenerated), not only these links.
|
||||
Reference in New Issue
Block a user