mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-10 19:19:18 +02:00
fcac837bd9
Revised multiple documentation files to replace instances of "FrikaMF" with "gregCore," reflecting the updated naming conventions and project structure. This change enhances consistency and clarity across the documentation, ensuring that users and contributors have accurate information regarding the framework and its components.
Documentation layout (docs/)
This folder is the single source of truth for the public Docusaurus site. The app lives in the gregWiki repository root next to docs/; built pages are served under the /wiki base path.
How content is organized
| Area | Path | Purpose |
|---|---|---|
| Landing | intro → /wiki |
Mod author wiki home. |
| Topics hub | topics/ |
Cross-cutting overviews (security, FFI, multiplayer, assets, meta). |
| Mods & plugins | mods/, plugins/ |
Gameplay mods (FMF.*) and framework plugins (greg.Plugin.* / FFM.Plugin.* depending on repo). |
| Releases | releases/ |
Per-artifact release notes. |
| Reference | reference/ |
Hooks, naming, MCP, generated catalogs. |
| Contributors | contributors/ |
Repo layout, Docusaurus workflow, design system. |
| Guides | guides/ |
Players: /players. Authors: mod developers, contributors, sponsors. |
| Roadmap | roadmap/ |
Planning docs. |
| Meta | meta/ |
Workshop, devserver, backlog; architecture principles (ModManager → Framework → Plugins → Mods). |
URLs
- Doc id
intro→/wiki(seeintro.md,slug: /). - Most docs →
/wiki/<doc-path>(e.g.mods/framework→/wiki/mods/framework).
Scripts (repository root)
| Script | Role |
|---|---|
wiki:sync |
No-op (legacy GitHub Wiki mirror removed). |
wiki:normalize-i18n |
No-op (same). |
wiki:refresh |
Runs both no-ops; safe for old CI hooks. |
Author new pages under docs/; use git history if you need text from the former bulk import.
Language
- English only — all files under
docs/.