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

Files

Marvin ea92a0baf8 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 quality.

2026-04-10 01:20:22 +02:00

2.9 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/legacy/wiki-import, sorted in the sidebar, and kept in sync with the repo.

Legacy wiki import

All material under docs/legacy/wiki-import/ is part of the GitHub Wiki mirror: it tracks the wiki that lives alongside the repository, while the rest of docs/ holds curated pages (guides, framework, reference).

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

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 i18n/de/.../legacy/wiki-import/.
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 gregFramework/ (sibling to your repo clones):
```
git clone https://github.com/<org>/<repo>.wiki.git .wiki
```
From gregWiki/ (the Docusaurus app):
```
npm run wiki:refresh
```
This runs wiki:sync (copy .wiki → docs/legacy/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/legacy/wiki-import/ and i18n/de/.../legacy/wiki-import/ as needed, then open a PR.

Editorial policy (recommended)

Goal	Action
Short-term fix on the live site	Edit files under `docs/legacy/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/guides/`, `docs/reference/`, or `docs/framework/`, 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 Legacy lists the full tree (autogenerated), not only these links.

2.9 KiB Raw Blame History Unescape Escape