mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
ea92a0baf8
- 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.
47 lines
2.8 KiB
Markdown
47 lines
2.8 KiB
Markdown
---
|
|
id: intro
|
|
title: gregFramework documentation
|
|
slug: /docs
|
|
description: Entry point for the split-repo workspace — core, mods, extensions, and this wiki.
|
|
---
|
|
|
|
This documentation describes the **current split layout**: a local `gregFramework/` workspace with separate repositories for **core**, **mods**, **extensions**, and **wiki**. It is written for **players**, **mod developers**, **contributors**, and **sponsors**.
|
|
|
|
## Who is this for?
|
|
|
|
| Audience | Start here |
|
|
|----------|------------|
|
|
| **Players** — install, play, troubleshoot | [End users (hub)](./guides/players/overview.md) · [End user wiki (import)](./legacy/wiki-import/EndUser/) |
|
|
| **Mod developers** — build mods, hooks, debugging | [Mod developers (hub)](./guides/mod-developers/overview.md) · [ModDevs wiki (import)](./legacy/wiki-import/ModDevs/) · [Framework](./mods/framework.md) |
|
|
| **Contributors** — PRs, docs, plugins, CI | [Contributors (workflow)](./guides/contributors/topics-overview.md) · [Contributors wiki (import)](./legacy/wiki-import/Contributors/) |
|
|
| **Sponsors** — support & transparency | [Sponsors (hub)](./guides/sponsors/overview.md) · [Sponsors (EN)](./legacy/wiki-import/Sponsors) · [Sponsoren (DE)](./legacy/wiki-import/Sponsoren) |
|
|
|
|
**Experience tracks** (newbies → pros): [By audience](./guides/players/audiences-overview.md) → [Newbies](./guides/players/newbies.md), [Intermediates](./guides/players/intermediates.md), [Professionals](./guides/players/professionals.md).
|
|
|
|
## Repository hub
|
|
|
|
- [Workspace map](./workspace/index.mdx) — how folders map to repos
|
|
- **Framework core:** `gregCore/` → `FrikaMF-StandaloneRepo/` (translations, hooks, runtime, templates, bridges)
|
|
- Mods: `gregMods/` (repos `gregMod.<Name>`)
|
|
- Extensions: `gregExtensions/` (repos `gregExt.<Name>`)
|
|
- Wiki: `gregWiki/` (this site)
|
|
|
|
## Hooks and releases
|
|
|
|
- [Modding language (C# only)](./reference/modding-language-requirement.md) — **all** mod, plugin, and extension logic must be **C#**
|
|
- [FMF hook naming](./reference/fmf-hook-naming.md) — `FMF.<Domain>.…` and legacy `FFM.*`
|
|
- [FMF hooks catalog](./reference/fmf-hooks-catalog.md) — generated from core `HookNames.cs`
|
|
- [Release channels](./reference/release-channels.md) — Steam Workshop vs GitHub (beta)
|
|
- [MCP server](./reference/mcp-server.md) — optional LLM/IDE tooling over docs + `fmf_hooks.json`
|
|
|
|
## Layout (contributors)
|
|
|
|
- [Repo inventory](./contributors/repo-inventory.md) — project and repository overview
|
|
- Split naming: `gregMod.<Name>`, `gregExt.<Name>`, `gregSta.<Name>`
|
|
|
|
## Source model
|
|
|
|
- **Authoring:** Markdown/MDX lives in the **gregWiki** repository.
|
|
- **Technical source of truth:** the **framework core** is **gregCore** — translations, hooks, and runtime/bridge implementation live there.
|
|
- **Rust bridge:** integrated in the core tree under `FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`.
|