mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
docs(wiki): update architecture and getting-started for split repos
This commit is contained in:
20
intro.md
20
intro.md
@@ -4,7 +4,7 @@ title: FrikaMF Docs Start
|
||||
slug: /docs
|
||||
---
|
||||
|
||||
This documentation matches the **current monorepo**: MelonLoader framework under `framework/`, gameplay mods under `mods/`, FFM plugins under `plugins/`, Docusaurus content in `docs/`, and the wiki app in `wiki/`. It is written for **players**, **mod developers**, **contributors**, and **sponsors** — pick a lane below.
|
||||
Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` als Wrapper mit Einzel-Repositories für Core, Mods, Extensions und Wiki. Sie richtet sich an **Spieler**, **Mod-Developer**, **Contributors** und **Sponsoren**.
|
||||
|
||||
## Für wen? — Who is this for?
|
||||
|
||||
@@ -17,10 +17,12 @@ This documentation matches the **current monorepo**: MelonLoader framework under
|
||||
|
||||
**Experience tracks** (newbies → pros): [By audience](./topics/audiences/overview.md) → [Newbies](./audiences/newbies.md), [Intermediates](./audiences/intermediates.md), [Professionals](./audiences/professionals.md).
|
||||
|
||||
## Mods Hub
|
||||
## Repository Hub
|
||||
|
||||
- Framework entry: [`Framework`](./mods/framework.md)
|
||||
- Standalone / mod list: [`Standalone Mods`](./mods/standalone/index.md)
|
||||
- Core: `gregCore/FrikaMF-StandaloneRepo/`
|
||||
- Mods: `gregMods/` (Repos `gregMod.<Name>`)
|
||||
- Extensions: `gregExtensions/` (Repos `gregExt.<Name>`)
|
||||
- Wiki: `gregWiki/`
|
||||
|
||||
## Hooks and releases
|
||||
|
||||
@@ -31,11 +33,11 @@ This documentation matches the **current monorepo**: MelonLoader framework under
|
||||
|
||||
## Repository layout (contributors)
|
||||
|
||||
- [Repo inventory](./contributors/repo-inventory.md) — projects, solution scope, entry points
|
||||
- [Monorepo target layout](./contributors/monorepo-target-layout.md) — phased migration goals
|
||||
- [Repo inventory](./contributors/repo-inventory.md) — aktuelle Projekt-/Repo-Übersicht
|
||||
- Split-Konvention: `gregMod.<Name>`, `gregExt.<Name>`, `gregSta.<Name>`
|
||||
|
||||
## Source model
|
||||
|
||||
- **Authoring:** Markdown and MDX live in the repo-root **`docs/`** folder (this tree). See the **[`docs/` layout map](./README.md)** for what lives where (curated topics vs `wiki-import/` vs `wiki/` stubs).
|
||||
- **Site:** The Docusaurus application is in **`wiki/`**; routes use base **`/wiki`** (see [Docusaurus workflow](./contributors/docusaurus-workflow.md)).
|
||||
- **Legacy GitHub Wiki:** Mirrored under **`docs/wiki-import/`**; refresh from **`.wiki/`** with `npm run wiki:refresh` in `wiki/`. Details: [Legacy wiki import](./topics/wiki-import/overview.md).
|
||||
- **Authoring:** Inhalte liegen im `gregWiki`-Repo.
|
||||
- **Core source of truth:** technische Runtime-/Bridge-Details kommen aus `gregCore`.
|
||||
- **RustBridge:** ist im Core integriert unter `FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`.
|
||||
|
||||
Reference in New Issue
Block a user