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

@@ -4,51 +4,91 @@ const sidebars = {
'intro',
{
type: 'category',
label: 'Workspace layout',
label: 'Getting started',
items: ['getting-started', 'getting-started/documentation-layout'],
},
{
type: 'category',
label: 'Workspace',
items: ['workspace/index'],
},
{
type: 'category',
label: 'Framework',
items: ['framework/architecture', 'framework/fmf-hooks', 'framework/hexmod'],
},
{
type: 'category',
label: 'Plugins (FFM)',
items: [
'README',
'getting-started',
'architecture',
'fmf-hooks',
'hexmod',
'workshop-uploader',
'plugins/index',
'plugins/ffm-plugin-asset-exporter',
'plugins/ffm-plugin-multiplayer',
'plugins/ffm-plugin-player-models',
'plugins/ffm-plugin-sysadmin',
'plugins/ffm-plugin-web-ui-bridge',
],
},
{
type: 'category',
label: 'Mods',
label: 'Mods (FMF)',
link: {type: 'doc', id: 'mods/index'},
items: [
'mods/index',
'mods/framework',
{
type: 'category',
label: 'Plugin Wiki',
items: [
'mods/extensions/index',
'mods/extensions/ffm-plugin-asset-exporter',
'mods/extensions/ffm-plugin-multiplayer',
'mods/extensions/ffm-plugin-player-models',
'mods/extensions/ffm-plugin-sysadmin',
'mods/extensions/ffm-plugin-web-ui-bridge',
],
},
{
type: 'category',
label: 'Mod Wiki',
items: [
'mods/mods/index',
'mods/mods/fmf-console-input-guard',
'mods/mods/fmf-gregify-employees',
'mods/extensions/fmf-hex-label-mod',
'mods/extensions/fmf-lang-compat-bridge',
'mods/extensions/fmf-ui-replacement-mod',
],
},
'mods/fmf-console-input-guard',
'mods/fmf-gregify-employees',
'mods/fmf-hex-label-mod',
'mods/fmf-lang-compat-bridge',
'mods/fmf-ui-replacement-mod',
],
},
{
type: 'category',
label: 'Tools & operations',
items: [
'tools/workshop-uploader',
'meta/Steam-Workshop-and-Tooling',
'meta/devserver-betas',
'meta/IDEA_BACKLOG',
],
},
{
type: 'category',
label: 'Guides',
items: ['guides/enduser-workshop', 'guides/contributor-workshop', 'guides/release'],
items: [
{
type: 'category',
label: 'Players',
items: [
'guides/players/overview',
'guides/players/audiences-overview',
'guides/players/newbies',
'guides/players/intermediates',
'guides/players/professionals',
'guides/players/enduser-workshop',
],
},
{
type: 'category',
label: 'Mod developers',
items: ['guides/mod-developers/overview'],
},
{
type: 'category',
label: 'Contributors',
items: [
'guides/contributors/topics-overview',
'guides/contributors/contributor-workshop',
'guides/contributors/release',
],
},
{
type: 'category',
label: 'Sponsors',
items: ['guides/sponsors/overview'],
},
],
},
{
type: 'category',
@@ -87,79 +127,71 @@ const sidebars = {
},
{
type: 'category',
label: 'Topics',
label: 'Reference',
items: [
'reference/wiki-mapping',
'reference/mod-store-vision',
'reference/fmf-hook-naming',
'reference/modding-language-requirement',
'reference/fmf-hooks-catalog',
'reference/mcp-server',
'reference/release-channels',
'reference/reference-data-files',
],
},
{
type: 'category',
label: 'Contributors (workflow)',
items: [
'contributors/repo-inventory',
'contributors/monorepo-target-layout',
'contributors/luminescent-design-system',
'contributors/docusaurus-workflow',
'contributors/plugin-submission-audit',
'contributors/sponsorship-automation',
],
},
{
type: 'category',
label: 'Roadmap',
items: ['roadmap/unified-roadmap', 'roadmap/mod-store-stages'],
},
{
type: 'category',
label: 'Topics hub',
link: {type: 'doc', id: 'topics/index'},
items: [
'topics/index',
{
type: 'category',
label: 'Audiences & roles',
items: [
'topics/audiences/overview',
'topics/end-user/overview',
'topics/mod-developers/overview',
'topics/contributors/overview',
'topics/sponsors/overview',
'audiences/newbies',
'audiences/intermediates',
'audiences/professionals',
],
},
{
type: 'category',
label: 'Reference & technical',
label: 'Cross-cutting topics',
items: [
'topics/assets-and-export/overview',
'topics/multiplayer-and-networking/overview',
'topics/ffi-and-hooks/overview',
'topics/security-legal/overview',
'topics/reference/overview',
'reference/wiki-mapping',
'reference/mod-store-vision',
'reference/fmf-hook-naming',
'reference/fmf-hooks-catalog',
'reference/mcp-server',
'reference/release-channels',
],
},
{
type: 'category',
label: 'Roadmap & planning',
items: ['topics/roadmap/overview', 'roadmap/unified-roadmap', 'roadmap/mod-store-stages'],
},
{
type: 'category',
label: 'Contributors (workflow)',
items: [
'topics/contributors/overview',
'contributors/repo-inventory',
'contributors/monorepo-target-layout',
'contributors/luminescent-design-system',
'contributors/docusaurus-workflow',
'contributors/plugin-submission-audit',
],
},
{
type: 'category',
label: 'Legacy wiki import',
link: {type: 'doc', id: 'topics/wiki-import/overview'},
items: [
'topics/wiki-import/overview',
{
type: 'autogenerated',
dirName: 'wiki-import',
},
],
},
{
type: 'category',
label: 'Meta & operations',
items: [
'topics/roadmap/overview',
'topics/meta/overview',
'topics/meta/game-folder-layout',
'meta/Steam-Workshop-and-Tooling',
'meta/devserver-betas',
'meta/IDEA_BACKLOG',
],
},
],
},
{
type: 'category',
label: 'Legacy',
link: {type: 'doc', id: 'legacy/index'},
items: [
'legacy/index',
'topics/wiki-import/overview',
{
type: 'autogenerated',
dirName: 'legacy/wiki-import',
},
],
},
'SPONSORS',
],
};