teamGreg/gregWiki
1
0
Fork 0
mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor: update project branding and structure for gregFramework

Browse Source 
- 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
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/getting-started.md
View File

@@ -6,12 +6,13 @@ description: "Split-repo workspace: gregFramework layout, building the core, and
The workspace is **multi-repo** with a local `gregFramework/` folder containing standalone repositories, for example:
- `gregCore/` (core SDK, including `FrikaMF-StandaloneRepo/`)
- `gregCore/` — **framework core** (under `FrikaMF-StandaloneRepo/`): translations, hooks, Harmony/event runtime, templates, bridges, and related core features
- `gregMods/` (per-mod repositories)
- `gregExtensions/` (per-extension repositories)
- `gregWiki/` (this documentation site)
- `gregStore/` (**Gregweb**, private repository — modstore web + infra; Next.js under `web/`)
`DataCenter-RustBridge` is integrated into the core tree at:
The upstream **DataCenter-RustBridge** project is integrated into the core tree at:
- `gregCore/FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`
@@ -23,6 +24,10 @@ dotnet build gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln -c Release
Or open `gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln` in your IDE.
## Language (mods / plugins / extensions)
**Mandatory:** implement **all** gameplay and integration logic for mods, MelonLoader plugins, and extensions in **C#**. See [Modding language (C# only)](./reference/modding-language-requirement.md).
## Hook naming
- **Target convention:** `FMF.<DOMAIN>.<Event>` (see [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/master/CONTRIBUTING.md)).