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:
19
docs/guides/contributors/topics-overview.md
Normal file
19
docs/guides/contributors/topics-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/guides/players/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/legacy/wiki-import/Contributors/Guides/Contribution-Workflow).
|
||||
14
docs/guides/mod-developers/overview.md
Normal file
14
docs/guides/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 legacy wiki-import ModDevs tree.
|
||||
---
|
||||
|
||||
# Mod developers
|
||||
|
||||
**Mod-Autorinnen und -Autoren** — eigene Mods bauen (Hooks, Konfiguration, Debug). Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview).
|
||||
|
||||
- [By audience — intermediates / professionals](/wiki/guides/players/intermediates) and [professionals](/wiki/guides/players/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)
|
||||
30
docs/guides/players/audiences-overview.md
Normal file
30
docs/guides/players/audiences-overview.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
id: audiences-overview
|
||||
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 `legacy/wiki-import/` wo vorhanden.
|
||||
|
||||
## 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) |
|
||||
|
||||
## Erfahrungsstufen (alle Rollen)
|
||||
|
||||
- [Newbies](./newbies) — erste Schritte, Begriffe, sichere Defaults.
|
||||
- [Intermediates](./intermediates) — Workflows, Tooling, typische Stolpersteine.
|
||||
- [Professionals](./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).
|
||||
30
docs/guides/players/intermediates.md
Normal file
30
docs/guides/players/intermediates.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
id: intermediates
|
||||
title: Intermediates
|
||||
slug: /audiences/intermediates
|
||||
---
|
||||
|
||||
## Goal
|
||||
|
||||
Build and debug your own mods with stable framework workflows.
|
||||
|
||||
## Learning path
|
||||
|
||||
1. Pick one track: C# or Rust.
|
||||
2. Learn hooks/events flow.
|
||||
3. Use verified targets from `HOOKS.md`.
|
||||
4. Implement mod config and diagnostics.
|
||||
|
||||
## Read next
|
||||
|
||||
- `.wiki/Mod-Developer-Debug.md`
|
||||
- `.wiki/Mod-Developer-Debug-en.md`
|
||||
- `.wiki/Modding-Guide.md`
|
||||
- `.wiki/FFI-Bridge-Reference.md`
|
||||
- `.wiki/Web-UI-Bridge.md`
|
||||
|
||||
## Practical checkpoints
|
||||
|
||||
- Build passes in debug/release
|
||||
- Hook target is verified in `HOOKS.md`
|
||||
- Events are version-safe and documented
|
||||
29
docs/guides/players/newbies.md
Normal file
29
docs/guides/players/newbies.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
id: newbies
|
||||
title: Newbies
|
||||
slug: /audiences/newbies
|
||||
---
|
||||
|
||||
## Goal
|
||||
|
||||
Get FrikaMF running safely and understand the minimum concepts.
|
||||
|
||||
## Start here
|
||||
|
||||
1. Install MelonLoader and run the game once.
|
||||
2. Copy `FrikaModdingFramework.dll` into `Data Center/Mods`.
|
||||
3. Add the mod that depends on FrikaMF.
|
||||
4. Check `MelonLoader/Latest.log`.
|
||||
|
||||
## Read next
|
||||
|
||||
- `.wiki/End-User-Release.md`
|
||||
- `.wiki/End-User-Release-en.md`
|
||||
- `.wiki/Known-Incompatibilities-en.md`
|
||||
- `.wiki/Bekannte-Inkompatibilitaeten.md`
|
||||
|
||||
## Common mistakes
|
||||
|
||||
- Wrong folder (`Mods` vs `RustMods`)
|
||||
- Missing first game start after MelonLoader install
|
||||
- Mixing incompatible game/framework versions
|
||||
13
docs/guides/players/overview.md
Normal file
13
docs/guides/players/overview.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: End users
|
||||
sidebar_label: End users (hub)
|
||||
description: FAQs, install paths, troubleshooting — plus legacy wiki-import entry points.
|
||||
---
|
||||
|
||||
# End users
|
||||
|
||||
**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/guides/players/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)
|
||||
32
docs/guides/players/professionals.md
Normal file
32
docs/guides/players/professionals.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
id: professionals
|
||||
title: Pros
|
||||
slug: /audiences/professionals
|
||||
---
|
||||
|
||||
## Goal
|
||||
|
||||
Work on framework internals, ABI stability, CI quality, and long-term maintainability.
|
||||
|
||||
## Focus areas
|
||||
|
||||
- Runtime architecture and ownership boundaries
|
||||
- C#↔Rust ABI evolution
|
||||
- Compatibility arbitration and diagnostics
|
||||
- Release assets and template integrity
|
||||
- Security review pipeline for future Mod Store
|
||||
|
||||
## Read next
|
||||
|
||||
- `.wiki/Architecture.md`
|
||||
- `.wiki/Framework-Features-Use-Cases.md`
|
||||
- `.wiki/StandaloneMods.md`
|
||||
- `.wiki/Repository-Status-2026-04-04.md`
|
||||
- `.wiki/ROADMAP.md`
|
||||
- `.wiki/TASKLIST.md`
|
||||
|
||||
## Professional quality gates
|
||||
|
||||
- Explicit migration notes for contracts/events
|
||||
- Reproducible build and release pipelines
|
||||
- Documented rollback and incompatibility strategy
|
||||
24
docs/guides/sponsors/overview.md
Normal file
24
docs/guides/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/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.
|
||||
|
||||
:::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