mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
526a9629ae
- Revised the documentation layout to reflect updated paths for various sections, including workspace, framework, plugins, mods, tools, guides, releases, reference, contributors, roadmap, topics hub, meta, and legacy. - Adjusted links to ensure they point to the correct files, enhancing navigation and accessibility within the documentation. - Improved descriptions in the Mods and Plugins sections to clarify the distinction between gameplay mods and framework plugins. This commit enhances the overall structure and usability of the documentation.
gregWiki — gregFramework documentation
This repository contains the Docusaurus site (docusaurus.config.js, src/, sidebars.js) and all Markdown/MDX content under docs/. Published docs use the route base path /wiki.
Local development
npm install
npm run start
Production build:
npm run build
Optional: refresh the legacy GitHub Wiki mirror from a sibling ../.wiki/ clone under gregFramework/ — see docs/getting-started/documentation-layout.md and npm run wiki:sync / wiki:normalize-i18n.
Deployment (Coolify / CI)
- Default branch:
main— use this for new work and PRs. master: kept in sync withmainfor hosts that still clonemaster(e.g. older Coolify defaults). Prefer setting the deployment branch tomainin Coolify → Application → Git → Branch.
Docker
Build context must be this repository root (the folder that contains package.json):
docker compose up --build
# or
docker build -t gregwiki-docs .
docker run --rm -p 3000:3000 gregwiki-docs
Related repositories
The gregFramework workspace groups gregCore, gregMods, gregExtensions, gregWiki, and related tools. Source-of-truth code paths for hooks and builds live in those repos, not only in this documentation tree.