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

Files

Marvin e2839584f4 Merge Docusaurus site: all content under docs/, align with gregFramework split layout

- Move markdown and wiki-import tree into docs/; keep app shell at repo root
- Point docusaurus docs path to docs/; edit links to mleem97/gregWiki
- Sync and i18n scripts use gregWiki root and ../.wiki under gregFramework
- Sidebars: workspace layout from root docs ids; plugins under mods/extensions
- Fix redirects, module catalog URLs, release note paths, and wiki-import category keys
- Update repo inventory for split repos; Dockerfile for single-repo context

Made-with: Cursor

2026-04-09 23:39:32 +02:00

2.8 KiB

Raw Blame History

title, sidebar_label, description

title	sidebar_label	description
Legacy wiki import	Legacy wiki import	How GitHub Wiki content is mirrored into docs/wiki-import, sorted in the sidebar, and kept in sync with the repo.

Legacy wiki import

All material under docs/wiki-import/ is part of the GitHub Wiki mirror: it is meant to track the wiki that lives alongside the repository, while the rest of docs/ holds curated pages (topics, mods, reference).

For a map of the whole docs/ tree, see Documentation layout (docs/).

Why this exists

Search & versioning: Wiki text is in Git, reviewable in PRs, and indexed by the site.
i18n: Paired Page.md (DE) + Page-en.md (EN) are split by wiki:normalize-i18n into the default locale and wiki/i18n/de/....
Sorting: Audience trees (EndUser/, ModDevs/, Contributors/, TechnicalReference/, DataCenterFAQ/) use _category_.json positions so the sidebar order matches intent, not only A–Z. Root Home uses sidebar_position: 1 so it appears first among loose pages.

Keep the mirror up to date

Clone or pull the wiki repo into .wiki/ at the repository root (same level as docs/):
```
git clone https://github.com/<org>/<repo>.wiki.git .wiki
```
From wiki/ (the Docusaurus app):
```
npm run wiki:refresh
```
This runs wiki:sync (copy .wiki → docs/wiki-import/) and then wiki:normalize-i18n. If .wiki is missing, wiki:sync exits with an error; run wiki:normalize-i18n alone only when you are fixing splits without pulling the wiki.
Commit changes under docs/wiki-import/ and wiki/i18n/de/... as needed, then open a PR.

Editorial policy (recommended)

Goal	Action
Short-term fix on the live site	Edit files under `docs/wiki-import/` (and DE mirror if applicable). Optionally backport to `.wiki` so the next sync does not overwrite you.
Canonical, long-term doc	Add or move content into `docs/topics/`, `docs/reference/`, or `docs/mods/`, and link from the legacy page.
Duplicate path	The folder `Contirbutors/` is a typo duplicate of `Contributors/`; prefer `Contributors/` for new links.

Entry points (English default locale)

Home — audience hub.
End users · Mod developers · Contributors
Technical reference · Data Center FAQ
HOOKS · FFI bridge reference

The sidebar Topics → Legacy wiki import lists the full tree (autogenerated), not only these links.

2.8 KiB Raw Blame History Unescape Escape