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

@@ -26,12 +26,16 @@ function toTitleCase(value: ReleaseKind): string {
function normalizeReleaseNotesPath(releaseNotesPath?: string): string | undefined {
if (!releaseNotesPath) return undefined;
if (releaseNotesPath.startsWith('/mods/')) {
return `/wiki${releaseNotesPath}`;
}
if (releaseNotesPath.startsWith('/wiki/')) {
return releaseNotesPath;
}
if (
releaseNotesPath.startsWith('/mods/') ||
releaseNotesPath.startsWith('/plugins/') ||
releaseNotesPath.startsWith('/tools/')
) {
return `/wiki${releaseNotesPath}`;
}
return releaseNotesPath;
}

View File

@@ -25,7 +25,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'gregFramework'],
wikiPath: '/wiki/mods/extensions/ffm-plugin-asset-exporter',
wikiPath: '/wiki/plugins/ffm-plugin-asset-exporter',
releasePath: '/wiki/releases/plugins/ffm-plugin-asset-exporter-release',
downloadPath: '/plugin/FFM.Plugin.AssetExporter.dll',
releaseReady: false,
@@ -39,7 +39,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'gregFramework'],
wikiPath: '/wiki/mods/extensions/ffm-plugin-multiplayer',
wikiPath: '/wiki/plugins/ffm-plugin-multiplayer',
releasePath: '/wiki/releases/plugins/ffm-plugin-multiplayer-release',
downloadPath: '/plugin/FFM.Plugin.Multiplayer.dll',
releaseReady: false,
@@ -53,7 +53,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'gregFramework'],
wikiPath: '/wiki/mods/extensions/ffm-plugin-player-models',
wikiPath: '/wiki/plugins/ffm-plugin-player-models',
releasePath: '/wiki/releases/plugins/ffm-plugin-player-models-release',
downloadPath: '/plugin/FFM.Plugin.PlayerModels.dll',
releaseReady: false,
@@ -67,7 +67,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'gregFramework'],
wikiPath: '/wiki/mods/extensions/ffm-plugin-sysadmin',
wikiPath: '/wiki/plugins/ffm-plugin-sysadmin',
releasePath: '/wiki/releases/plugins/ffm-plugin-sysadmin-release',
downloadPath: '/plugin/FFM.Plugin.Sysadmin.dll',
releaseReady: false,
@@ -81,7 +81,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'gregFramework'],
wikiPath: '/wiki/mods/extensions/ffm-plugin-web-ui-bridge',
wikiPath: '/wiki/plugins/ffm-plugin-web-ui-bridge',
releasePath: '/wiki/releases/plugins/ffm-plugin-web-ui-bridge-release',
downloadPath: '/plugin/FFM.Plugin.WebUIBridge.dll',
releaseReady: false,
@@ -90,13 +90,12 @@ export const moduleCatalog: ModuleEntry[] = [
id: 'fmf-modpathredirector',
name: 'FMF.ModPathRedirector',
type: 'plugin',
description:
'MelonLoader plugin: waits for each subscribed Workshop item (Steam + StreamingAssets/Mods/workshop_*) before MelonMods load.',
description: 'MelonLoader plugin: waits for each subscribed Workshop item (Steam + StreamingAssets/Mods/workshop_*) before MelonMods load.',
version: '1.5.0',
author: 'DataCenterExporter / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'Steam client'],
wikiPath: '/wiki/workshop-uploader',
wikiPath: '/wiki/tools/workshop-uploader',
releasePath: '/wiki/releases/plugins/fmf-modpathredirector-release',
downloadPath: '/plugin/FMF.ModPathRedirector.dll',
releaseReady: true,
@@ -110,7 +109,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'Harmony'],
wikiPath: '/wiki/mods/mods/fmf-console-input-guard',
wikiPath: '/wiki/mods/fmf-console-input-guard',
releasePath: '/wiki/releases/mods/fmf-console-input-guard-release',
downloadPath: '/mod/FMF.ConsoleInputGuard.dll',
releaseReady: false,
@@ -124,7 +123,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'Harmony'],
wikiPath: '/wiki/mods/mods/fmf-gregify-employees',
wikiPath: '/wiki/mods/fmf-gregify-employees',
releasePath: '/wiki/releases/mods/fmf-gregify-employees-release',
downloadPath: '/mod/FMF.GregifyEmployees.dll',
releaseReady: false,
@@ -138,7 +137,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'Harmony'],
wikiPath: '/wiki/mods/extensions/fmf-hex-label-mod',
wikiPath: '/wiki/mods/fmf-hex-label-mod',
releasePath: '/wiki/releases/mods/fmf-hex-label-mod-release',
downloadPath: '/mod/FMF.HexLabelMod.dll',
releaseReady: false,
@@ -152,7 +151,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader'],
wikiPath: '/wiki/mods/extensions/fmf-lang-compat-bridge',
wikiPath: '/wiki/mods/fmf-lang-compat-bridge',
releasePath: '/wiki/releases/mods/fmf-lang-compat-bridge-release',
downloadPath: '/mod/FMF.JoniMLCompatMod.dll',
releaseReady: false,
@@ -166,7 +165,7 @@ export const moduleCatalog: ModuleEntry[] = [
author: 'mleem97 / gregFramework Community',
languages: ['C#'],
dependencies: ['MelonLoader', 'Harmony'],
wikiPath: '/wiki/mods/extensions/fmf-ui-replacement-mod',
wikiPath: '/wiki/mods/fmf-ui-replacement-mod',
releasePath: '/wiki/releases/mods/fmf-ui-replacement-mod-release',
downloadPath: '/mod/FMF.UIReplacementMod.dll',
releaseReady: false,

View File

@@ -9,11 +9,11 @@ export const sharedKnowledgeLinksEn: HomepageDocLink[] = [
link: '/wiki/mods/framework',
},
{
title: 'Plugin Wiki',
description: 'Plugin-specific docs and release pages.',
link: '/wiki/mods/extensions/',
title: 'Plugins (FFM)',
description: 'FFM.Plugin.* docs and release pages.',
link: '/wiki/plugins/',
},
{ title: 'Mod Wiki', description: 'Gameplay mods, releases, and module docs.', link: '/wiki/mods/mods' },
{ title: 'Mods (FMF)', description: 'Gameplay mods, releases, and module docs.', link: '/wiki/mods/' },
{
title: 'FMF Hooks Catalog',
description: 'Hook strings and event IDs generated from core sources.',
@@ -36,12 +36,12 @@ export const sharedWorkflowLinksEn: HomepageDocLink[] = [
{
title: 'End-user docs',
description: 'Install, update, and troubleshooting paths.',
link: '/wiki/wiki-import/EndUser/End-User-Release',
link: '/wiki/legacy/wiki-import/EndUser/End-User-Release',
},
{
title: 'Mod developer docs',
description: 'Setup, debugging, and hook integration.',
link: '/wiki/wiki-import/ModDevs/Mod-Developer-Debug',
link: '/wiki/legacy/wiki-import/ModDevs/Mod-Developer-Debug',
},
{
title: 'Repo inventory',
@@ -68,11 +68,11 @@ export const sharedKnowledgeLinksDe: HomepageDocLink[] = [
link: '/wiki/mods/framework',
},
{
title: 'Plugin-Wiki',
description: 'Plugin-Doku und Release-Seiten.',
link: '/wiki/mods/extensions/',
title: 'Plugins (FFM)',
description: 'FFM.Plugin.*-Doku und Release-Seiten.',
link: '/wiki/plugins/',
},
{ title: 'Mod-Wiki', description: 'Gameplay-Mods, Releases und Modul-Doku.', link: '/wiki/mods/mods' },
{ title: 'Mods (FMF)', description: 'Gameplay-Mods, Releases und Modul-Doku.', link: '/wiki/mods/' },
{
title: 'FMF-Hooks-Katalog',
description: 'Hook-Strings und Event-IDs aus den Core-Quellen.',
@@ -95,12 +95,12 @@ export const sharedWorkflowLinksDe: HomepageDocLink[] = [
{
title: 'Endnutzer-Doku',
description: 'Installation, Updates und Fehlerbehebung.',
link: '/wiki/wiki-import/EndUser/End-User-Release',
link: '/wiki/legacy/wiki-import/EndUser/End-User-Release',
},
{
title: 'Mod-Entwickler-Doku',
description: 'Setup, Debugging und Hook-Integration.',
link: '/wiki/wiki-import/ModDevs/Mod-Developer-Debug',
link: '/wiki/legacy/wiki-import/ModDevs/Mod-Developer-Debug',
},
{
title: 'Repo-Inventar',