docs: update docusaurus configuration and documentation structure

- Revised the tagline in `docusaurus.config.js` for improved clarity on the documentation's focus.
- Removed German localization support from the configuration to streamline the user experience.
- Updated navigation items in the sidebar to better reflect the current structure, emphasizing player and developer resources.
- Enhanced the README and various documentation files to clarify the repository layout and improve accessibility for users.
- Adjusted links and descriptions throughout the documentation to ensure consistency and accuracy.

This commit aims to enhance the overall clarity and usability of the documentation.
This commit is contained in:
Marvin
2026-04-10 02:26:32 +02:00
parent 8d8fda49c4
commit 331847013d
50 changed files with 634 additions and 1070 deletions

View File

@@ -1,50 +1,9 @@
import {existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync} from 'node:fs';
import {join, resolve} from 'node:path';
const projectRoot = resolve(process.cwd());
const gregFrameworkRoot = resolve(projectRoot, '..');
const wikiDir = join(gregFrameworkRoot, '.wiki');
const outDir = join(projectRoot, 'docs', 'legacy', 'wiki-import');
if (!existsSync(wikiDir)) {
console.error(
`Missing ${wikiDir}. Clone or restore the GitHub Wiki working tree there, then re-run this script.\n` +
'Existing files under docs/legacy/wiki-import/ are left unchanged.',
);
process.exit(1);
}
mkdirSync(outDir, {recursive: true});
function collectMarkdownFiles(rootDir, prefix = '') {
const entries = readdirSync(join(rootDir, prefix), {withFileTypes: true});
const results = [];
for (const entry of entries) {
const relativePath = prefix ? join(prefix, entry.name) : entry.name;
if (entry.isDirectory()) {
results.push(...collectMarkdownFiles(rootDir, relativePath));
continue;
}
if (entry.isFile() && entry.name.toLowerCase().endsWith('.md')) {
results.push(relativePath);
}
}
return results;
}
const files = collectMarkdownFiles(wikiDir);
for (const file of files) {
const source = join(wikiDir, file);
const sanitizedRelative = file.replace(/\s+/g, '-');
const target = join(outDir, sanitizedRelative);
const targetDir = resolve(target, '..');
mkdirSync(targetDir, {recursive: true});
const raw = readFileSync(source, 'utf8');
writeFileSync(target, raw, 'utf8');
}
console.log(`Synced ${files.length} wiki files to ${outDir}`);
/**
* Legacy GitHub Wiki → docs/ mirror. Removed: content now lives only under docs/ (curated).
* Keep this script as a no-op so old CI or docs do not reference a missing file.
*/
console.log(
'[wiki:sync] Skipped: the bulk wiki-import under docs/legacy/wiki-import/ was retired.\n' +
'Author and edit Markdown under docs/ in gregWiki; use git history for old mirror text.',
);
process.exit(0);