mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
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:
335
sidebars.js
335
sidebars.js
@@ -4,184 +4,191 @@ const sidebars = {
|
||||
'intro',
|
||||
{
|
||||
type: 'category',
|
||||
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)',
|
||||
label: 'Play & mods',
|
||||
collapsed: false,
|
||||
items: [
|
||||
'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 (FMF)',
|
||||
link: {type: 'doc', id: 'mods/index'},
|
||||
items: [
|
||||
'mods/index',
|
||||
'mods/framework',
|
||||
'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: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Players',
|
||||
key: 'guides-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',
|
||||
key: 'guides-mod-developers',
|
||||
items: ['guides/mod-developers/overview'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Contributors',
|
||||
key: 'guides-contributors',
|
||||
items: [
|
||||
'guides/contributors/topics-overview',
|
||||
'guides/contributors/contributor-workshop',
|
||||
'guides/contributors/release',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Sponsors',
|
||||
key: 'guides-sponsors',
|
||||
items: ['guides/sponsors/overview'],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Releases',
|
||||
link: {type: 'doc', id: 'releases/index'},
|
||||
items: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Plugin releases',
|
||||
items: [
|
||||
'releases/plugins/ffm-plugin-asset-exporter-release',
|
||||
'releases/plugins/ffm-plugin-multiplayer-release',
|
||||
'releases/plugins/ffm-plugin-player-models-release',
|
||||
'releases/plugins/ffm-plugin-sysadmin-release',
|
||||
'releases/plugins/ffm-plugin-web-ui-bridge-release',
|
||||
'releases/plugins/fmf-modpathredirector-release',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tool releases',
|
||||
items: ['releases/tools/gregtools-modmanager-1.0-release'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Mod releases',
|
||||
items: [
|
||||
'releases/mods/fmf-console-input-guard-release',
|
||||
'releases/mods/fmf-gregify-employees-release',
|
||||
'releases/mods/fmf-hex-label-mod-release',
|
||||
'releases/mods/fmf-lang-compat-bridge-release',
|
||||
'releases/mods/fmf-ui-replacement-mod-release',
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Reference',
|
||||
items: [
|
||||
'reference/wiki-mapping',
|
||||
'reference/mod-store-vision',
|
||||
'reference/fmf-hook-naming',
|
||||
'reference/fmf-hooks-catalog',
|
||||
'reference/mcp-server',
|
||||
'guides/players/overview',
|
||||
'guides/players/enduser-workshop',
|
||||
'reference/release-channels',
|
||||
'reference/reference-data-files',
|
||||
],
|
||||
},
|
||||
'tools/workshop-uploader',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Contributors (workflow)',
|
||||
label: 'Developers & contributors',
|
||||
collapsed: true,
|
||||
link: {type: 'doc', id: 'developers'},
|
||||
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',
|
||||
'developers',
|
||||
'meta/system-architecture-principles',
|
||||
'getting-started',
|
||||
'getting-started/documentation-layout',
|
||||
'workspace/index',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Cross-cutting topics',
|
||||
label: 'Framework',
|
||||
items: ['framework/architecture', 'framework/fmf-hooks', 'framework/hexmod'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Plugins (FFM)',
|
||||
items: [
|
||||
'topics/assets-and-export/overview',
|
||||
'topics/multiplayer-and-networking/overview',
|
||||
'topics/ffi-and-hooks/overview',
|
||||
'topics/security-legal/overview',
|
||||
'topics/reference/overview',
|
||||
'topics/roadmap/overview',
|
||||
'topics/meta/overview',
|
||||
'topics/meta/game-folder-layout',
|
||||
'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 (FMF)',
|
||||
link: {type: 'doc', id: 'mods/index'},
|
||||
items: [
|
||||
'mods/index',
|
||||
'mods/framework',
|
||||
'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: [
|
||||
'meta/Steam-Workshop-and-Tooling',
|
||||
'meta/devserver-betas',
|
||||
'meta/IDEA_BACKLOG',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Guides',
|
||||
items: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Players (extra)',
|
||||
items: [
|
||||
'guides/players/audiences-overview',
|
||||
'guides/players/newbies',
|
||||
'guides/players/intermediates',
|
||||
'guides/players/professionals',
|
||||
],
|
||||
},
|
||||
{
|
||||
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',
|
||||
label: 'Releases',
|
||||
link: {type: 'doc', id: 'releases/index'},
|
||||
items: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Plugin releases',
|
||||
items: [
|
||||
'releases/plugins/ffm-plugin-asset-exporter-release',
|
||||
'releases/plugins/ffm-plugin-multiplayer-release',
|
||||
'releases/plugins/ffm-plugin-player-models-release',
|
||||
'releases/plugins/ffm-plugin-sysadmin-release',
|
||||
'releases/plugins/ffm-plugin-web-ui-bridge-release',
|
||||
'releases/plugins/fmf-modpathredirector-release',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tool releases',
|
||||
items: ['releases/tools/gregtools-modmanager-1.0-release'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Mod releases',
|
||||
items: [
|
||||
'releases/mods/fmf-console-input-guard-release',
|
||||
'releases/mods/fmf-gregify-employees-release',
|
||||
'releases/mods/fmf-hex-label-mod-release',
|
||||
'releases/mods/fmf-lang-compat-bridge-release',
|
||||
'releases/mods/fmf-ui-replacement-mod-release',
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Reference',
|
||||
items: [
|
||||
'reference/wiki-mapping',
|
||||
'reference/mod-store-vision',
|
||||
'reference/fmf-hook-naming',
|
||||
'reference/fmf-hooks-catalog',
|
||||
'reference/mcp-server',
|
||||
'reference/reference-data-files',
|
||||
'reference/modding-language-requirement',
|
||||
],
|
||||
},
|
||||
{
|
||||
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: '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',
|
||||
'topics/roadmap/overview',
|
||||
'topics/meta/overview',
|
||||
'topics/meta/game-folder-layout',
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
'SPONSORS',
|
||||
],
|
||||
},
|
||||
'SPONSORS',
|
||||
],
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user