docs: refine documentation structure and language consistency

- Updated the tagline in `docusaurus.config.js` for improved clarity.
- Streamlined sidebar navigation items for better organization of player and developer resources.
- Enhanced README and various documentation files to clarify repository layout and improve accessibility.
- Standardized language to English across documentation, ensuring consistency and clarity.
- Removed unnecessary German localization references to focus on English content.

This commit aims to enhance the overall clarity and usability of the documentation.
This commit is contained in:
Marvin
2026-04-10 02:36:47 +02:00
parent 331847013d
commit 3b245ee966
12 changed files with 191 additions and 291 deletions

View File

@@ -1,8 +1,13 @@
import {en} from './en';
import type {HomepageContent} from './types';
import type {HomepageContent, LocaleKey} from './types';
const homepageByLocale: Record<LocaleKey, HomepageContent> = {
en,
};
export type {HomepageContent, LocaleKey} from './types';
export function getHomepageContent(_locale: string): HomepageContent {
return en;
export function getHomepageContent(locale: string): HomepageContent {
void locale;
return homepageByLocale.en;
}

View File

@@ -40,44 +40,6 @@ export const sharedWorkflowLinksEn: HomepageDocLink[] = [
},
];
export const sharedKnowledgeLinksDe: HomepageDocLink[] = [
{title: 'Wiki-Start', description: 'Kurzüberblick — Spieler vs. Entwickler.', link: '/wiki'},
{
title: 'Für Spieler',
description: 'Installation, Updates, Fehlerbehebung.',
link: '/wiki/guides/players/overview',
},
{
title: 'WorkshopManager',
description: 'Workshop-Mods suchen und installieren.',
link: '/wiki/guides/players/enduser-workshop',
},
{
title: 'Release-Kanäle',
description: 'Steam Workshop vs GitHub.',
link: '/wiki/reference/release-channels',
},
{title: 'Mod-Katalog', description: 'Module mit Doku- und Download-Links.', link: '/mods'},
];
export const sharedWorkflowLinksDe: HomepageDocLink[] = [
{
title: 'Entwickler (Hub)',
description: 'Framework, Mods, Plugins, Referenz — alle technischen Links.',
link: '/wiki/developers',
},
{
title: 'Mod-Entwickler-Guide',
description: 'Hooks, Setup, Einstieg.',
link: '/wiki/guides/mod-developers/overview',
},
{
title: 'Contributor-Workflow',
description: 'Doku-Site und Repo-Konventionen.',
link: '/wiki/contributors/docusaurus-workflow',
},
];
export const homepageShellEn: Pick<
HomepageContent,
| 'heroBadge'
@@ -107,33 +69,3 @@ export const homepageShellEn: Pick<
knowledgeLinks: sharedKnowledgeLinksEn,
workflowLinks: sharedWorkflowLinksEn,
};
export const homepageShellDe: Pick<
HomepageContent,
| 'heroBadge'
| 'heroBrandLine1'
| 'heroBrandLine2Gradient'
| 'knowledgeSectionTitle'
| 'workflowSectionTitle'
| 'codeSectionTitle'
| 'codeSectionLead'
| 'ctaDiscordTitle'
| 'ctaDiscordLead'
| 'ctaDiscordButton'
| 'knowledgeLinks'
| 'workflowLinks'
> = {
heroBadge: 'gregFramework · Live-Dokumentation',
heroBrandLine1: 'greg',
heroBrandLine2Gradient: 'Framework',
knowledgeSectionTitle: 'Spieler — Einstieg',
workflowSectionTitle: 'Autoren & Contributors',
codeSectionTitle: 'Auf gregFramework aufbauen',
codeSectionLead:
'C#-Mods auf MelonLoader, FFM-Plugins, optionale Rust-Brücken — Details für Autoren unter Entwickler.',
ctaDiscordTitle: 'Community',
ctaDiscordLead: 'Fragen zum Spielen oder Bauen — im Discord.',
ctaDiscordButton: 'Discord beitreten',
knowledgeLinks: sharedKnowledgeLinksDe,
workflowLinks: sharedWorkflowLinksDe,
};

View File

@@ -11,7 +11,7 @@ export type ModsPageStrings = {
legacyNoSplitRepo: string;
};
const strings: ModsPageStrings = {
const en: ModsPageStrings = {
title: 'Mods & plugins catalog',
description:
'Generated from the module catalog. Each entry links to its wiki article, release page, and download route.',
@@ -26,5 +26,6 @@ const strings: ModsPageStrings = {
};
export function getModsPageStrings(_locale: string): ModsPageStrings {
return strings;
void _locale;
return en;
}