2.8 KiB
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 bywiki:normalize-i18ninto the default locale andwiki/i18n/de/.... - Sorting: Audience trees (
EndUser/,ModDevs/,Contributors/,TechnicalReference/,DataCenterFAQ/) use_category_.jsonpositions so the sidebar order matches intent, not only A–Z. RootHomeusessidebar_position: 1so 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 asdocs/):git clone https://github.com/<org>/<repo>.wiki.git .wiki -
From
wiki/(the Docusaurus app):npm run wiki:refreshThis runs
wiki:sync(copy.wiki→docs/wiki-import/) and thenwiki:normalize-i18n. If.wikiis missing,wiki:syncexits with an error; runwiki:normalize-i18nalone only when you are fixing splits without pulling the wiki. -
Commit changes under
docs/wiki-import/andwiki/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.