mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
docs: update docusaurus configuration and documentation structure
- Revised the tagline in `docusaurus.config.js` for improved clarity on the documentation's focus. - Removed German localization support from the configuration to streamline the user experience. - Updated navigation items in the sidebar to better reflect the current structure, emphasizing player and developer resources. - Enhanced the README and various documentation files to clarify the repository layout and improve accessibility for users. - Adjusted links and descriptions throughout the documentation to ensure consistency and accuracy. This commit aims to enhance the overall clarity and usability of the documentation.
This commit is contained in:
Marvin
@@ -6,14 +6,14 @@ 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/guides/players/audiences-overview).
|
||||
**Repository contributors** — framework, website, CI, plugins. Role overview (including players, mod developers, sponsors): [By audience](/wiki/guides/players/audiences-overview).
|
||||
|
||||
Operational docs for people changing the framework, site, or release pipeline.
|
||||
|
||||
- [System architecture & documentation principles](/wiki/meta/system-architecture-principles) — layer model, priorities, wiki rules (**required reading** for substantive doc changes).
|
||||
- [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.
|
||||
|
||||
- [Contributor workshop](./contributor-workshop) — branching, reviews, and release expectations.
|
||||
|
||||
@@ -6,8 +6,9 @@ description: Getting started, mod config, debugging — curated docs for FMF mod
|
||||
|
||||
# Mod developers
|
||||
|
||||
**Mod-Autorinnen und -Autoren** — eigene Mods bauen (Hooks, Konfiguration, Debug). Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview).
|
||||
**Mod authors** — build your own mods (hooks, configuration, debugging). Role overview: [By audience](/wiki/guides/players/audiences-overview).
|
||||
|
||||
- [System architecture & documentation principles](/wiki/meta/system-architecture-principles) — layer model **ModManager → Framework → Plugins → Mods**, priorities, wiki rules
|
||||
- [By audience — intermediates](/wiki/audiences/intermediates) and [professionals](/wiki/audiences/professionals)
|
||||
- [Framework overview](/wiki/mods/framework) — runtime capabilities and repo layout
|
||||
- [FMF hooks](/wiki/framework/fmf-hooks) — hook surface (generated article)
|
||||
|
||||
@@ -2,28 +2,28 @@
|
||||
id: audiences-overview
|
||||
title: By audience
|
||||
sidebar_label: By audience
|
||||
description: Vier Rollen — Spieler, Moddevs, Contributor, Sponsoren — plus Erfahrungsstufen (Newbies bis Pros).
|
||||
description: Four roles — players, mod developers, contributors, sponsors — plus experience levels (newbies through pros).
|
||||
---
|
||||
|
||||
# By audience
|
||||
|
||||
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`).
|
||||
Documentation is aimed at **four primary roles** (and experience levels under each). All curated pages are **English**.
|
||||
|
||||
## Die vier Rollen
|
||||
## The four roles
|
||||
|
||||
| Rolle | Für wen? | Einstieg |
|
||||
| Role | Who | Start here |
|
||||
|--------|----------|----------|
|
||||
| **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) |
|
||||
| **Players** (end users) | Install, use mods, troubleshooting | [End users (hub)](./overview) · [End-user workshop](./enduser-workshop) |
|
||||
| **Mod developers** | Build mods, hooks, configuration, debugging | [Mod developers (hub)](../mod-developers/overview) · [Framework](/wiki/mods/framework) |
|
||||
| **Contributors** (repo & framework) | PRs, docs, plugins, CI | [Contributors (workflow)](../contributors/topics-overview) · [Repo inventory](/wiki/contributors/repo-inventory) |
|
||||
| **Sponsors** | Support, transparency | [Sponsors (hub)](../sponsors/overview) |
|
||||
|
||||
## Erfahrungsstufen (alle Rollen)
|
||||
## Experience levels (all roles)
|
||||
|
||||
- [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.
|
||||
- [Newbies](/wiki/audiences/newbies) — first steps, terminology, safe defaults.
|
||||
- [Intermediates](/wiki/audiences/intermediates) — workflows, tooling, common pitfalls.
|
||||
- [Professionals](/wiki/audiences/professionals) — architecture, FFI, performance, release channels.
|
||||
|
||||
## Thematische Übersicht
|
||||
## Thematic overview
|
||||
|
||||
- [Topics hub](/wiki/topics/) — Security, Multiplayer, Assets, FFI, Roadmap, Meta.
|
||||
- [Topics hub](/wiki/topics/) — security, multiplayer, assets, FFI, roadmap, meta.
|
||||
|
||||
@@ -6,7 +6,7 @@ description: FAQs, install paths, troubleshooting — entry point for players us
|
||||
|
||||
# End users
|
||||
|
||||
**Spielerinnen und Spieler** — Mods installieren und spielen, ohne am Framework mitzuentwickeln. Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview).
|
||||
**Players** — install and play with mods without developing the framework. Role overview: [By audience](/wiki/guides/players/audiences-overview).
|
||||
|
||||
- [By audience — newbies](/wiki/audiences/newbies)
|
||||
- [End-user workshop](/wiki/guides/players/enduser-workshop) — install, updates, Workshop
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
title: Sponsors & support
|
||||
sidebar_label: Sponsors (hub)
|
||||
description: Für Unterstützerinnen und Unterstützer — Sponsoring, Transparenz, Anlaufstellen.
|
||||
description: For supporters — sponsorship, transparency, where to start.
|
||||
---
|
||||
|
||||
# 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).
|
||||
The community funds infrastructure, tools, and time to maintain documentation and the framework. Use this page if you are a **potential sponsor** (or a player who wants to see where support goes).
|
||||
|
||||
## Kurzüberblick
|
||||
## At a glance
|
||||
|
||||
- **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.
|
||||
- **GitHub:** [mleem97/gregFramework](https://github.com/mleem97/gregFramework) — sponsorship and community policies are in `README`, `LICENSE`, and `CONTRIBUTING`.
|
||||
- **Transparency:** Release notes and [Release channels](/wiki/reference/release-channels) describe how builds are distributed.
|
||||
- **Legal:** [Security & legal](/wiki/topics/security-legal/overview) — binding text lives in the repository, not only in the 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).
|
||||
:::note Audience
|
||||
This page is for **sponsors and supporters**. Players start at [End users](/wiki/guides/players/overview); mod authors at [Mod developers](/wiki/guides/mod-developers/overview); repo contributors at [Contributors (workflow)](/wiki/guides/contributors/topics-overview).
|
||||
:::
|
||||
|
||||
Reference in New Issue
Block a user