gregWiki/docs/intro.md at 31cd24b462b5e03de8c5eff57364cf8fe4ec2bff

mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00

Files

Marvin c46717b3cf 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 structure.

2026-04-09 23:54:50 +02:00

2.4 KiB

Raw Blame History

id, title, slug, description

id	title	slug	description
intro	gregFramework documentation	/docs	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) · End user wiki (import)
Mod developers — build mods, hooks, debugging	Mod developers (hub) · ModDevs wiki (import) · Framework
Contributors — PRs, docs, plugins, CI	Contributors (workflow) · Contributors wiki (import)
Sponsors — support & transparency	Sponsors (hub) · Sponsors (EN) · Sponsoren (DE)

Experience tracks (newbies → pros): By audience → Newbies, Intermediates, Professionals.

Repository hub

Core: gregCore/FrikaMF-StandaloneRepo/
Mods: gregMods/ (repos gregMod.<Name>)
Extensions: gregExtensions/ (repos gregExt.<Name>)
Wiki: gregWiki/ (this site)

Hooks and releases

FMF hook naming — FMF.<Domain>.… and legacy FFM.*
FMF hooks catalog — generated from core HookNames.cs
Release channels — Steam Workshop vs GitHub (beta)
MCP server — optional LLM/IDE tooling over docs + fmf_hooks.json

Layout (contributors)

Repo inventory — 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: runtime and bridge details come from gregCore.
Rust bridge: integrated in the core tree under FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/.

2.4 KiB Raw Blame History