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.
This commit is contained in:
Marvin
2026-04-10 01:20:22 +02:00
parent 31cd24b462
commit ea92a0baf8
295 changed files with 835 additions and 34708 deletions

View File

@@ -1,52 +1,52 @@
---
title: Legacy wiki import
sidebar_label: Legacy wiki import
description: How GitHub Wiki content is mirrored into docs/wiki-import, sorted in the sidebar, and kept in sync with the repo.
description: 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/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).
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 (`docs/`)](../../README.md)**.
For a **map of the whole `docs/` tree**, see **[Documentation layout](../../getting-started/documentation-layout.md)**.
## 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/...`.
- **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 AZ. Root **`Home`** uses `sidebar_position: 1` so it appears first among loose pages.
## Keep the mirror up to date
1. Clone or pull the wiki repo into **`.wiki/`** at the **repository root** (same level as `docs/`):
1. Clone or pull the wiki repo into **`.wiki/`** at **`gregFramework/`** (sibling to your repo clones):
```bash
git clone https://github.com/<org>/<repo>.wiki.git .wiki
```
2. From **`wiki/`** (the Docusaurus app):
2. From **`gregWiki/`** (the Docusaurus app):
```bash
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.
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.
3. Commit changes under **`docs/wiki-import/`** and **`wiki/i18n/de/...`** as needed, then open a PR.
3. 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/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. |
| **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](/wiki/wiki-import/Home) — audience hub.
- [End users](/wiki/wiki-import/EndUser/) · [Mod developers](/wiki/wiki-import/ModDevs/) · [Contributors](/wiki/wiki-import/Contributors/)
- [Technical reference](/wiki/wiki-import/TechnicalReference/) · [Data Center FAQ](/wiki/wiki-import/DataCenterFAQ/)
- [HOOKS](/wiki/wiki-import/HOOKS) · [FFI bridge reference](/wiki/wiki-import/FFI-Bridge-Reference)
- [Home](/wiki/legacy/wiki-import/Home) — audience hub.
- [End users](/wiki/legacy/wiki-import/EndUser/) · [Mod developers](/wiki/legacy/wiki-import/ModDevs/) · [Contributors](/wiki/legacy/wiki-import/Contributors/)
- [Technical reference](/wiki/legacy/wiki-import/TechnicalReference/) · [Data Center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/)
- [HOOKS](/wiki/legacy/wiki-import/HOOKS) · [FFI bridge reference](/wiki/legacy/wiki-import/FFI-Bridge-Reference)
The sidebar **Topics → Legacy wiki import** lists the **full** tree (autogenerated), not only these links.
The sidebar **Legacy** lists the **full** tree (autogenerated), not only these links.