mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
ea92a0baf8
- 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.
53 lines
2.9 KiB
Markdown
53 lines
2.9 KiB
Markdown
---
|
||
title: Legacy wiki import
|
||
sidebar_label: Legacy wiki import
|
||
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/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](../../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 `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
|
||
|
||
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 **`gregWiki/`** (the Docusaurus app):
|
||
|
||
```bash
|
||
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.
|
||
|
||
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/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/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 **Legacy** lists the **full** tree (autogenerated), not only these links.
|