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
@@ -16,4 +16,4 @@ Operational docs for people changing the framework, site, or release pipeline.
|
||||
- [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/legacy/wiki-import/Contributors/Guides/Contribution-Workflow).
|
||||
- [Contributor workshop](./contributor-workshop) — branching, reviews, and release expectations.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Mod developers
|
||||
sidebar_label: Mod developers (hub)
|
||||
description: Getting started, mod config, debugging — links into legacy wiki-import ModDevs tree.
|
||||
description: Getting started, mod config, debugging — curated docs for FMF mod authors.
|
||||
---
|
||||
|
||||
# Mod developers
|
||||
@@ -9,6 +9,8 @@ description: Getting started, mod config, debugging — links into legacy wiki-i
|
||||
**Mod-Autorinnen und -Autoren** — eigene Mods bauen (Hooks, Konfiguration, Debug). Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview).
|
||||
|
||||
- [By audience — intermediates](/wiki/audiences/intermediates) and [professionals](/wiki/audiences/professionals)
|
||||
- Wiki: [Framework overview](/wiki/mods/framework)
|
||||
- Imported: [ModDevs](/wiki/legacy/wiki-import/ModDevs/), [Modding guide](/wiki/legacy/wiki-import/Modding-Guide), [Mod config system](/wiki/legacy/wiki-import/Mod-Config-System)
|
||||
- Imported: [Standalone mods](/wiki/legacy/wiki-import/StandaloneMods)
|
||||
- [Framework overview](/wiki/mods/framework) — runtime capabilities and repo layout
|
||||
- [FMF hooks](/wiki/framework/fmf-hooks) — hook surface (generated article)
|
||||
- [FMF hook naming](/wiki/reference/fmf-hook-naming) and [hooks catalog](/wiki/reference/fmf-hooks-catalog)
|
||||
- [Contributor workshop](/wiki/guides/contributors/contributor-workshop) — builds, CI, and PRs
|
||||
- [Mods](/wiki/mods/) — gameplay mods (`FMF.*`) and release pages
|
||||
|
||||
@@ -7,16 +7,16 @@ description: Vier Rollen — Spieler, Moddevs, Contributor, Sponsoren — plus E
|
||||
|
||||
# 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 `legacy/wiki-import/` wo vorhanden.
|
||||
Die Dokumentation richtet sich an **vier Hauptrollen** (und an Erfahrungsstufen darunter). Die meisten Seiten sind **Englisch**; ausgewählte Einstiege gibt es auch auf **Deutsch** (z. B. in dieser Übersicht und in `i18n/de`).
|
||||
|
||||
## Die vier Rollen
|
||||
|
||||
| Rolle | Für wen? | Einstieg |
|
||||
|--------|----------|----------|
|
||||
| **Spieler** (End users) | Installation, Mods nutzen, Troubleshooting, FAQ | [End users (hub)](./overview) → [End user wiki](/wiki/legacy/wiki-import/EndUser/), [Data center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/) |
|
||||
| **Mod-Entwickler** (Mod developers) | Mods bauen, Hooks, Konfiguration, Debug | [Mod developers (hub)](../mod-developers/overview) → [ModDevs wiki](/wiki/legacy/wiki-import/ModDevs/), [Framework](/wiki/mods/framework) |
|
||||
| **Contributor** (Repo & Framework) | PRs, Doku, Plugins, CI, Design | [Contributors (workflow)](../contributors/topics-overview) → [Contributors wiki](/wiki/legacy/wiki-import/Contributors/), [Repo inventory](/wiki/contributors/repo-inventory) |
|
||||
| **Sponsorinnen & Sponsoren** | Unterstützung, Transparenz, rechtlicher Kontext | [Sponsors (hub)](../sponsors/overview) → [Sponsors (EN)](/wiki/legacy/wiki-import/Sponsors), [Sponsoren (DE)](/wiki/legacy/wiki-import/Sponsoren) |
|
||||
| **Spieler** (End users) | Installation, Mods nutzen, Troubleshooting | [End users (hub)](./overview) · [End-user workshop](./enduser-workshop) |
|
||||
| **Mod-Entwickler** (Mod developers) | Mods bauen, Hooks, Konfiguration, Debug | [Mod developers (hub)](../mod-developers/overview) · [Framework](/wiki/mods/framework) |
|
||||
| **Contributor** (Repo & Framework) | PRs, Doku, Plugins, CI | [Contributors (workflow)](../contributors/topics-overview) · [Repo inventory](/wiki/contributors/repo-inventory) |
|
||||
| **Sponsorinnen & Sponsoren** | Unterstützung, Transparenz | [Sponsors (hub)](../sponsors/overview) |
|
||||
|
||||
## Erfahrungsstufen (alle Rollen)
|
||||
|
||||
@@ -27,4 +27,3 @@ Die Dokumentation richtet sich an **vier Hauptrollen** (und an Erfahrungsstufen
|
||||
## Thematische Übersicht
|
||||
|
||||
- [Topics hub](/wiki/topics/) — Security, Multiplayer, Assets, FFI, Roadmap, Meta.
|
||||
- Importierte Legacy-Guides: [Legacy wiki import](/wiki/topics/wiki-import/overview).
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: End users
|
||||
sidebar_label: End users (hub)
|
||||
description: FAQs, install paths, troubleshooting — plus legacy wiki-import entry points.
|
||||
description: FAQs, install paths, troubleshooting — entry point for players using mods.
|
||||
---
|
||||
|
||||
# End users
|
||||
@@ -9,5 +9,6 @@ description: FAQs, install paths, troubleshooting — plus legacy wiki-import en
|
||||
**Spielerinnen und Spieler** — Mods installieren und spielen, ohne am Framework mitzuentwickeln. Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview).
|
||||
|
||||
- [By audience — newbies](/wiki/audiences/newbies)
|
||||
- Imported: [End user index](/wiki/legacy/wiki-import/EndUser/), [Data center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/), [Known incompatibilities](/wiki/legacy/wiki-import/Known-Incompatibilities)
|
||||
- Imported: [End user release notes](/wiki/legacy/wiki-import/EndUser/End-User-Release)
|
||||
- [End-user workshop](/wiki/guides/players/enduser-workshop) — install, updates, Workshop
|
||||
- [Workshop uploader (tool)](/wiki/tools/workshop-uploader) — publishing and project metadata
|
||||
- [Release channels](/wiki/reference/release-channels) — Steam vs GitHub discovery
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Sponsors & support
|
||||
sidebar_label: Sponsors (hub)
|
||||
description: Für Unterstützerinnen und Unterstützer — Sponsoring, Transparenz, englische Detailseiten.
|
||||
description: Für Unterstützerinnen und Unterstützer — Sponsoring, Transparenz, Anlaufstellen.
|
||||
---
|
||||
|
||||
# Sponsors & support
|
||||
@@ -10,14 +10,9 @@ Die Community finanziert u. a. Infrastruktur, Tools und Zeit für Pflege der Dok
|
||||
|
||||
## Kurzüberblick
|
||||
|
||||
- **Englisch (ausführlich):** [Sponsors (EN)](/wiki/legacy/wiki-import/Sponsors) — Optionen (z. B. GitHub Sponsors), Nutzung von Mitteln, rechtlicher Kontext.
|
||||
- **Deutsch:** [Sponsoren](/wiki/legacy/wiki-import/Sponsoren) — gleiche Themen, wo vorhanden auf Deutsch.
|
||||
- **Dank:** [Community Thanks](/wiki/legacy/wiki-import/Community-Thanks) (Import), [Changelog & versions](/wiki/legacy/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/legacy/wiki-import/License-Legal) — rechtlicher Rahmen des Projekts.
|
||||
- **GitHub:** [mleem97/gregFramework](https://github.com/mleem97/gregFramework) — Sponsoring- und Community-Richtlinien stehen in `README`, `LICENSE` und `CONTRIBUTING`.
|
||||
- **Transparenz:** Release-Notes und [Release-Kanäle](/wiki/reference/release-channels) beschreiben, wie Builds verteilt werden.
|
||||
- **Rechtliches:** [Security & legal](/wiki/topics/security-legal/overview) — verbindliche Texte liegen im Repository, nicht nur im Wiki.
|
||||
|
||||
:::note Zielgruppe
|
||||
Diese Seite richtet sich an **Sponsorinnen, Sponsoren und Fördernde**. Spielerinnen und Spieler finden den Einstieg unter [End users](/wiki/guides/players/overview); Mod-Autoren unter [Mod developers](/wiki/guides/mod-developers/overview); Mitwirkende am Repo unter [Contributors (workflow)](/wiki/guides/contributors/topics-overview).
|
||||
|
||||
Reference in New Issue
Block a user