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
2026-04-10 01:20:22 +02:00
parent 31cd24b462
commit ea92a0baf8
295 changed files with 835 additions and 34708 deletions

View File

@@ -6,12 +6,13 @@ description: "Split-Repo-Workspace: gregFramework-Layout, Core bauen und wo die
Die Struktur ist **Multi-Repo** mit `gregFramework/` als lokalem Wrapper-Ordner. Darin liegen die eigenständigen Repositories, z. B.:
- `gregCore/` (Core SDK, inkl. `FrikaMF-StandaloneRepo/`)
- `gregCore/` **Framework-Kern** (`FrikaMF-StandaloneRepo/`): Übersetzung, Hooks, Harmony-/Event-Laufzeit, Templates, Bridges und übrige Kernfunktionen
- `gregMods/` (einzelne Mod-Repos)
- `gregExtensions/` (einzelne Extension-Repos)
- `gregWiki/` (Dokumentation)
- `gregStore/` (**Gregweb**, privates Repository — Modstore Web + Infra; Next.js unter `web/`)
`DataCenter-RustBridge` wird in den Core integriert und liegt unter:
Das Upstream-Projekt **DataCenter-RustBridge** wird in den Core integriert und liegt unter:
- `gregCore/FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`
@@ -23,6 +24,10 @@ dotnet build gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln -c Release
Alternativ in der IDE: `gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln` öffnen.
## Sprache (Mods / Plugins / Extensions)
**Pflicht:** Gameplay- und Integrationslogik für Mods, MelonLoader-Plugins und Extensions ausschließlich in **C#**. Siehe [Modding-Sprache (nur C#)](/wiki/reference/modding-language-requirement).
## Hook-Naming
- **Zielkonvention:** `FMF.<DOMAIN>.<Event>` (siehe [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/master/CONTRIBUTING.md)).

View File

@@ -11,22 +11,24 @@ Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` a
| Zielgruppe | Einstieg |
|------------|----------|
| **Spieler** — installieren, spielen, Troubleshooting | [Endnutzer (Hub)](/wiki/topics/end-user/overview) · [Endnutzer-Wiki (Import)](/wiki/wiki-import/EndUser/) |
| **Moddevs** — Mods bauen, Hooks, Debugging | [Mod-Entwickler (Hub)](/wiki/topics/mod-developers/overview) · [ModDevs-Wiki (Import)](/wiki/wiki-import/ModDevs/) · [Framework](/wiki/mods/framework) |
| **Contributor** — PRs, Doku, Plugins, CI | [Contributors (Workflow)](/wiki/topics/contributors/overview) · [Contributors-Wiki (Import)](/wiki/wiki-import/Contributors/) |
| **Sponsorinnen & Sponsoren** | [Sponsors (Hub)](/wiki/topics/sponsors/overview) · [Sponsors (EN)](/wiki/wiki-import/Sponsors) · [Sponsoren (DE)](/wiki/wiki-import/Sponsoren) |
| **Spieler** — installieren, spielen, Troubleshooting | [Endnutzer (Hub)](/wiki/guides/players/overview) · [Endnutzer-Wiki (Import)](/wiki/legacy/wiki-import/EndUser/) |
| **Moddevs** — Mods bauen, Hooks, Debugging | [Mod-Entwickler (Hub)](/wiki/guides/mod-developers/overview) · [ModDevs-Wiki (Import)](/wiki/legacy/wiki-import/ModDevs/) · [Framework](/wiki/mods/framework) |
| **Contributor** — PRs, Doku, Plugins, CI | [Contributors (Workflow)](/wiki/guides/contributors/topics-overview) · [Contributors-Wiki (Import)](/wiki/legacy/wiki-import/Contributors/) |
| **Sponsorinnen & Sponsoren** | [Sponsors (Hub)](/wiki/guides/sponsors/overview) · [Sponsors (EN)](/wiki/legacy/wiki-import/Sponsors) · [Sponsoren (DE)](/wiki/legacy/wiki-import/Sponsoren) |
**Erfahrungspfade** (Einsteiger → Profis): [Nach Zielgruppe](/wiki/topics/audiences/overview) → [Newbies](/wiki/audiences/newbies), [Intermediates](/wiki/audiences/intermediates), [Professionals](/wiki/audiences/professionals).
**Erfahrungspfade** (Einsteiger → Profis): [Nach Zielgruppe](/wiki/guides/players/audiences-overview) → [Newbies](/wiki/guides/players/newbies), [Intermediates](/wiki/guides/players/intermediates), [Professionals](/wiki/guides/players/professionals).
## Repository-Hub
- Core: `gregCore/FrikaMF-StandaloneRepo/`
- [Workspace-Karte](/wiki/workspace/) — Ordner → Repos
- **Framework-Kern:** `gregCore/``FrikaMF-StandaloneRepo/` (Übersetzung, Hooks, Runtime, Templates, Bridges)
- Mods: `gregMods/` (Repos `gregMod.<Name>`)
- Extensions: `gregExtensions/` (Repos `gregExt.<Name>`)
- Wiki: `gregWiki/`
## Hooks und Releases
- [Modding-Sprache (nur C#)](/wiki/reference/modding-language-requirement) — **gesamte** Logik von Mods, Plugins und Extensions in **C#**
- [FMF Hook-Naming](/wiki/reference/fmf-hook-naming) — `FMF.<Domain>.…` und Legacy `FFM.*`
- [FMF-Hooks-Katalog](/wiki/reference/fmf-hooks-catalog) — generiert aus Core-`HookNames.cs`
- [Release-Kanäle](/wiki/reference/release-channels) — Steam Workshop vs GitHub (Beta)
@@ -40,5 +42,5 @@ Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` a
## Quellenmodell
- **Authoring:** Inhalte liegen im **gregWiki**-Repo.
- **Technische Wahrheit:** Runtime/Bridge-Details kommen aus **gregCore**.
- **Technische Wahrheit:** Der **Framework-Kern** ist **gregCore** — Übersetzung, Hooks und Runtime/Bridge-Implementierung liegen dort.
- **RustBridge:** im Core unter `FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`.

View File

@@ -10,7 +10,7 @@ tags:
This page is for contributors working on FrikaMF itself.
For the complete and maintainable feature matrix with implementation use cases, see [`Framework Features & Use Cases`](/wiki/wiki-import/Framework-Features-Use-Cases).
For the complete and maintainable feature matrix with implementation use cases, see [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases).
## Dev setup

View File

@@ -10,7 +10,7 @@ tags:
This page is for contributors working on FrikaMF itself.
For the complete and maintainable feature matrix with implementation use cases, see [`Framework Features & Use Cases`](/wiki/wiki-import/Framework-Features-Use-Cases).
For the complete and maintainable feature matrix with implementation use cases, see [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases).
## Dev setup

View File

@@ -10,7 +10,7 @@ tags:
This page is for players who do **not** develop mods and only install FrikaMF because another mod depends on it.
For a complete overview of framework capabilities and setup flows, see [`Framework Features & Use Cases`](/wiki/wiki-import/Framework-Features-Use-Cases).
For a complete overview of framework capabilities and setup flows, see [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases).
## What you install

View File

@@ -8,4 +8,4 @@
## Policies
- [AI Usage Policy (Wiki)](../../AI-USAGE)
- [AI Usage Policy (Root)](/wiki/wiki-import/AI-USAGE)
- [AI Usage Policy (Root)](/wiki/legacy/wiki-import/AI-USAGE)

View File

@@ -4,4 +4,4 @@ English mirror page.
The maintained canonical page is currently:
- [Framework Features & Use Cases](/wiki/wiki-import/Framework-Features-Use-Cases)
- [Framework Features & Use Cases](/wiki/legacy/wiki-import/Framework-Features-Use-Cases)

View File

@@ -25,7 +25,7 @@ Game updates may change signatures and hook points, breaking framework-level pat
1. Capture `MelonLoader/Latest.log`.
2. Confirm game/framework/mod versions.
3. Review [`HOOKS.md`](/wiki/wiki-import/HOOKS) and compatibility notes.
3. Review [`HOOKS.md`](/wiki/legacy/wiki-import/HOOKS) and compatibility notes.
## Compatibility matrix template

View File

@@ -10,7 +10,7 @@ tags:
You only need one track: **Rust** or **C#**. FrikaMF bridges runtime communication.
Full framework capability catalog with setup guides: [`Framework Features & Use Cases`](/wiki/wiki-import/Framework-Features-Use-Cases).
Full framework capability catalog with setup guides: [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases).
## Rust vs C# decision guide
@@ -37,7 +37,7 @@ Recommended approach:
For full DE/EN step-by-step tutorials per FFI entrypoint, see:
- [Lua FFI — How to Start Developing (DE + EN)](/wiki/wiki-import/Lua-FFI-Start-Developing)
- [Lua FFI — How to Start Developing (DE + EN)](/wiki/legacy/wiki-import/Lua-FFI-Start-Developing)
## Architecture
@@ -104,7 +104,7 @@ Interop assemblies often contain metadata-facing stubs; real implementation live
- It is not a generic network FFI transport bus.
- For Web FFI, implement your own HTTP/WebSocket gateway with validation and rate limits.
Config API reference: [`Mod Config System`](/wiki/wiki-import/Mod-Config-System)
Config API reference: [`Mod Config System`](/wiki/legacy/wiki-import/Mod-Config-System)
## Cross-track example

View File

@@ -5,4 +5,4 @@ English mirror page.
The maintained canonical page is currently:
- [Modding Guide](Modding-Guide)
- [Lua FFI — How to Start Developing (DE + EN)](/wiki/wiki-import/Lua-FFI-Start-Developing)
- [Lua FFI — How to Start Developing (DE + EN)](/wiki/legacy/wiki-import/Lua-FFI-Start-Developing)

View File

@@ -82,8 +82,8 @@ DC2WebBridge.RegisterWebApp(new Dc2WebAppDescriptor
## Related links
- [Framework Features & Use Cases](/wiki/wiki-import/Framework-Features-Use-Cases)
- [FFI Bridge Reference](/wiki/wiki-import/FFI-Bridge-Reference)
- [Framework Features & Use Cases](/wiki/legacy/wiki-import/Framework-Features-Use-Cases)
- [FFI Bridge Reference](/wiki/legacy/wiki-import/FFI-Bridge-Reference)
- [Mod-Developer (Debug) EN](Mod-Developer-Debug)
- [Contributors (Debug) EN](Contributors-Debug)
- [Web UI Bridge (DC2WEB)](/wiki/wiki-import/Web-UI-Bridge)
- [Web UI Bridge (DC2WEB)](/wiki/legacy/wiki-import/Web-UI-Bridge)

Some files were not shown because too many files have changed in this diff Show More