From 4ff8de41a63b36c32af15203fcea3ebe74dbcd5e Mon Sep 17 00:00:00 2001 From: frostebite Date: Thu, 14 May 2026 21:06:05 +0100 Subject: [PATCH 1/5] docs: group CI platform docs under one sidebar section --- sidebars.js | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index 65ecc5ce..d127e519 100644 --- a/sidebars.js +++ b/sidebars.js @@ -2,5 +2,24 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ module.exports = { - defaultSidebar: [{ type: 'autogenerated', dirName: '.' }], + defaultSidebar: [ + 'index', + { type: 'autogenerated', dirName: '02-getting-started' }, + { + type: 'category', + label: 'CI Platforms', + collapsed: false, + items: [ + { type: 'autogenerated', dirName: '03-github' }, + { type: 'autogenerated', dirName: '05-gitlab' }, + { type: 'autogenerated', dirName: '11-circleci' }, + { type: 'autogenerated', dirName: '12-self-hosting' }, + ], + }, + { type: 'autogenerated', dirName: '03-github-cli' }, + { type: 'autogenerated', dirName: '03-github-orchestrator' }, + { type: 'autogenerated', dirName: '08-docker' }, + { type: 'autogenerated', dirName: '09-troubleshooting' }, + { type: 'autogenerated', dirName: '10-faq' }, + ], }; From a84c2fd3b3cee86b3cc07eca1de931f62341ec24 Mon Sep 17 00:00:00 2001 From: frostebite Date: Thu, 14 May 2026 22:42:59 +0100 Subject: [PATCH 2/5] docs: group CI platform docs under one sidebar section --- sidebars.js | 171 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 166 insertions(+), 5 deletions(-) diff --git a/sidebars.js b/sidebars.js index d127e519..6dd3ca22 100644 --- a/sidebars.js +++ b/sidebars.js @@ -4,16 +4,177 @@ module.exports = { defaultSidebar: [ 'index', - { type: 'autogenerated', dirName: '02-getting-started' }, + { type: 'doc', id: 'getting-started/index', label: 'Getting started' }, { type: 'category', label: 'CI Platforms', collapsed: false, + collapsible: true, items: [ - { type: 'autogenerated', dirName: '03-github' }, - { type: 'autogenerated', dirName: '05-gitlab' }, - { type: 'autogenerated', dirName: '11-circleci' }, - { type: 'autogenerated', dirName: '12-self-hosting' }, + { + type: 'category', + label: 'GitHub (Default)', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'github/getting-started', label: 'Getting started' }, + { type: 'doc', id: 'github/activation', label: 'Activation' }, + { type: 'doc', id: 'github/test-runner', label: 'Test runner' }, + { type: 'doc', id: 'github/builder', label: 'Builder' }, + { type: 'doc', id: 'github/returning-a-license', label: 'Returning a license' }, + { + type: 'category', + label: 'Deployment', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'github/deployment/android', label: 'Deploy to Google Play' }, + { type: 'doc', id: 'github/deployment/ios', label: 'Deploy to the App Store' }, + { type: 'doc', id: 'github/deployment/steam', label: 'Deploy to Steam' }, + ], + }, + ], + }, + { + type: 'category', + label: 'GitLab', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'gitlab/getting-started', label: 'Getting started' }, + { type: 'doc', id: 'gitlab/activation', label: 'Activation' }, + { type: 'doc', id: 'gitlab/example-project', label: 'Example Project' }, + { type: 'doc', id: 'gitlab/custom-build-options', label: 'Custom build options' }, + { type: 'doc', id: 'gitlab/tests', label: 'Tests' }, + { + type: 'category', + label: 'Deployment', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'gitlab/deployment/android', label: 'Android' }, + { type: 'doc', id: 'gitlab/deployment/ios', label: 'iOS' }, + ], + }, + ], + }, + { + type: 'category', + label: 'CircleCI', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'circleci/getting-started', label: 'Getting started' }, + { type: 'doc', id: 'circleci/activation', label: 'Activation' }, + { type: 'doc', id: 'circleci/build', label: 'Build' }, + { type: 'doc', id: 'circleci/test', label: 'Test' }, + { type: 'doc', id: 'circleci/executors', label: 'Executors' }, + ], + }, + { + type: 'category', + label: 'Self-Hosting', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'self-hosting/overview', label: 'Overview' }, + { type: 'doc', id: 'self-hosting/host-types', label: 'Types of Hosts' }, + { + type: 'category', + label: 'Host Creation', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'self-hosting/host-creation/bare-metal', label: 'Bare-Metal' }, + { + type: 'doc', + id: 'self-hosting/host-creation/multipass', + label: 'VMs with Multipass (Basic)', + }, + { + type: 'category', + label: 'VMs with QEMU (Advanced)', + collapsible: true, + collapsed: true, + items: [ + { + type: 'doc', + id: 'self-hosting/host-creation/QEMU/overview', + label: 'Install QEMU', + }, + { + type: 'doc', + id: 'self-hosting/host-creation/QEMU/linux-cloudimage', + label: 'Linux (Cloud-Image)', + }, + { + type: 'doc', + id: 'self-hosting/host-creation/QEMU/linux-liveiso', + label: 'Linux (Live-ISO)', + }, + { + type: 'doc', + id: 'self-hosting/host-creation/QEMU/windows', + label: 'Windows', + }, + { type: 'doc', id: 'self-hosting/host-creation/QEMU/macos', label: 'MacOS' }, + { + type: 'doc', + id: 'self-hosting/host-creation/QEMU/configuration', + label: 'Advanced Configuration Options', + }, + ], + }, + ], + }, + { + type: 'category', + label: 'Host Provisioning', + collapsible: true, + collapsed: true, + items: [ + { + type: 'doc', + id: 'self-hosting/host-provisioning/debian-setup', + label: 'Debian Machine Setup', + }, + { + type: 'doc', + id: 'self-hosting/host-provisioning/ubuntu-setup', + label: 'Ubuntu Machine Setup', + }, + { + type: 'doc', + id: 'self-hosting/host-provisioning/cloud-init', + label: 'Declarative Provisioning using Cloud-Init', + }, + ], + }, + { + type: 'category', + label: 'Runner Application Installation', + collapsible: true, + collapsed: true, + items: [ + { + type: 'doc', + id: 'self-hosting/runner-application-installation/gitlab-pipelines', + label: 'Gitlab Pipelines', + }, + { + type: 'doc', + id: 'self-hosting/runner-application-installation/github-actions', + label: 'Github Actions', + }, + ], + }, + { + type: 'doc', + id: 'self-hosting/windows-runner-setup', + label: 'Windows Self-Hosted Runner Setup', + }, + ], + }, ], }, { type: 'autogenerated', dirName: '03-github-cli' }, From e472dd072146c1b89a84bb7452bdda960e44e81c Mon Sep 17 00:00:00 2001 From: frostebite Date: Thu, 14 May 2026 22:50:06 +0100 Subject: [PATCH 3/5] docs: preserve existing sidebar structure while grouping CI platforms --- sidebars.js | 326 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 321 insertions(+), 5 deletions(-) diff --git a/sidebars.js b/sidebars.js index 6dd3ca22..6421ffef 100644 --- a/sidebars.js +++ b/sidebars.js @@ -177,10 +177,326 @@ module.exports = { }, ], }, - { type: 'autogenerated', dirName: '03-github-cli' }, - { type: 'autogenerated', dirName: '03-github-orchestrator' }, - { type: 'autogenerated', dirName: '08-docker' }, - { type: 'autogenerated', dirName: '09-troubleshooting' }, - { type: 'autogenerated', dirName: '10-faq' }, + { + type: 'category', + label: 'CLI', + collapsible: true, + collapsed: false, + link: { type: 'doc', id: 'github-cli/index' }, + items: [ + { type: 'doc', id: 'github-cli/build', label: 'Engine Commands' }, + { type: 'doc', id: 'github-cli/remote-builds', label: 'Orchestrate' }, + { + type: 'doc', + id: 'github-cli/configuration-and-plugins', + label: 'Configuration and Plugins', + }, + { type: 'doc', id: 'github-cli/github-action', label: 'GitHub Action' }, + ], + }, + { + type: 'category', + label: 'Orchestrator', + collapsible: true, + collapsed: true, + items: [ + { + type: 'category', + label: 'Introduction to Orchestrator', + collapsible: true, + collapsed: false, + items: [ + { + type: 'doc', + id: 'github-orchestrator/introduction-to-orchestrator/introduction', + label: 'Introduction', + }, + { + type: 'doc', + id: 'github-orchestrator/introduction-to-orchestrator/game-ci-vs-orchestrator', + label: 'GameCI vs Orchestrator', + }, + { + type: 'doc', + id: 'github-orchestrator/introduction-to-orchestrator/getting-started', + label: 'Getting Started', + }, + { + type: 'category', + label: 'Examples', + collapsible: true, + collapsed: true, + items: [ + { + type: 'doc', + id: 'github-orchestrator/introduction-to-orchestrator/examples/command-line', + label: 'Command Line', + }, + { + type: 'doc', + id: 'github-orchestrator/introduction-to-orchestrator/examples/github-actions', + label: 'GitHub Actions', + }, + { + type: 'doc', + id: 'github-orchestrator/introduction-to-orchestrator/examples/aws', + label: 'AWS Examples', + }, + { + type: 'doc', + id: 'github-orchestrator/introduction-to-orchestrator/examples/kubernetes', + label: 'Kubernetes Examples', + }, + ], + }, + ], + }, + { type: 'doc', id: 'github-orchestrator/jobs', label: 'Orchestrator Jobs' }, + { + type: 'category', + label: 'Provider Types', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'github-orchestrator/providers/overview', label: 'Provider Types' }, + { type: 'doc', id: 'github-orchestrator/providers/aws', label: 'AWS' }, + { type: 'doc', id: 'github-orchestrator/providers/kubernetes', label: 'Kubernetes' }, + { + type: 'doc', + id: 'github-orchestrator/providers/github-actions-dispatch', + label: 'GitHub Actions Dispatch Provider', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/local-docker', + label: 'Local Docker', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/gitlab-ci-dispatch', + label: 'GitLab CI Dispatch Provider', + }, + { type: 'doc', id: 'github-orchestrator/providers/local', label: 'Local' }, + { + type: 'doc', + id: 'github-orchestrator/providers/custom-providers', + label: 'Custom Providers', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/remote-powershell', + label: 'Remote PowerShell Provider', + }, + { type: 'doc', id: 'github-orchestrator/providers/ansible', label: 'Ansible Provider' }, + { + type: 'doc', + id: 'github-orchestrator/providers/community-providers', + label: 'Community Providers', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/github-integration', + label: 'GitHub Integration', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/gitlab-integration', + label: 'GitLab Integration', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/gcp-cloud-run', + label: 'GCP Cloud Run (Experimental)', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/azure-aci', + label: 'Azure ACI (Experimental)', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/cli-provider-protocol', + label: 'CLI Provider Protocol', + }, + { + type: 'doc', + id: 'github-orchestrator/providers/config-defined-providers', + label: 'Config-Defined Providers', + }, + ], + }, + { type: 'doc', id: 'github-orchestrator/secrets', label: 'Secrets' }, + { + type: 'category', + label: 'Standalone CLI', + collapsible: true, + collapsed: true, + items: [ + { + type: 'doc', + id: 'github-orchestrator/cli/getting-started', + label: 'Standalone Orchestrator CLI', + }, + { + type: 'doc', + id: 'github-orchestrator/cli/build-command', + label: 'Build Command', + }, + { + type: 'doc', + id: 'github-orchestrator/cli/orchestrate-command', + label: 'Standalone Orchestrator Command', + }, + { + type: 'doc', + id: 'github-orchestrator/cli/other-commands', + label: 'Other Commands', + }, + { + type: 'doc', + id: 'github-orchestrator/cli/init-command', + label: 'Init Command', + }, + ], + }, + { + type: 'doc', + id: 'github-orchestrator/api-reference', + label: 'API Reference', + }, + { + type: 'category', + label: 'Advanced topics', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'github-orchestrator/advanced-topics/caching', label: 'Caching' }, + { + type: 'category', + label: 'Hooks', + collapsible: true, + collapsed: true, + items: [ + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/hooks/command-hooks', + label: 'Command Hooks', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/hooks/container-hooks', + label: 'Container Hooks', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/hooks/built-in-hooks', + label: 'Built-In Hooks', + }, + ], + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/load-balancing', + label: 'Load Balancing', + }, + { type: 'doc', id: 'github-orchestrator/advanced-topics/storage', label: 'Storage' }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/architecture', + label: 'Architecture', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/build-services', + label: 'Build Services', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/lfs-agents', + label: 'Custom LFS Agents', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/test-workflow-engine', + label: 'Test Workflow Engine', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/hot-runner-protocol', + label: 'Streaming Runner', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/large-projects', + label: 'Large Projects', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/monorepo-support', + label: 'Monorepo Support', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/build-reliability', + label: 'Build Reliability', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/engine-plugins', + label: 'Engine Plugins', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/unity-accelerator', + label: 'Unity Accelerator', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/self-hosting-and-orchestrator', + label: 'Self-Hosting and Orchestrator', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/failures-and-diagnostics', + label: 'Failures and Diagnostics', + }, + { + type: 'doc', + id: 'github-orchestrator/advanced-topics/unity-log-collection', + label: 'Unity Log Collection', + }, + ], + }, + ], + }, + { + type: 'category', + label: 'Docker', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'docker/docker-images', label: 'GameCI Docker images for Unity' }, + { type: 'doc', id: 'docker/windows-docker-images', label: 'Windows docker images' }, + { + type: 'doc', + id: 'docker/customize-docker-images', + label: 'Customize GameCI Unity Docker images', + }, + { type: 'doc', id: 'docker/versions', label: 'Versions' }, + { type: 'doc', id: 'docker/custom-images', label: 'Custom Images' }, + ], + }, + { + type: 'category', + label: 'Troubleshooting', + collapsible: true, + collapsed: true, + items: [{ type: 'doc', id: 'troubleshooting/common-issues', label: 'Common issues' }], + }, + { + type: 'doc', + id: 'faq/index', + label: 'Frequently Asked Questions (FAQ)', + }, ], }; From 9c8bb362b853616aa465231b21a5c268bdc3ec76 Mon Sep 17 00:00:00 2001 From: frostebite Date: Thu, 14 May 2026 22:52:41 +0100 Subject: [PATCH 4/5] docs: match requested docs sidebar order --- sidebars.js | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/sidebars.js b/sidebars.js index 6421ffef..1061d100 100644 --- a/sidebars.js +++ b/sidebars.js @@ -181,7 +181,7 @@ module.exports = { type: 'category', label: 'CLI', collapsible: true, - collapsed: false, + collapsed: true, link: { type: 'doc', id: 'github-cli/index' }, items: [ { type: 'doc', id: 'github-cli/build', label: 'Engine Commands' }, @@ -194,6 +194,23 @@ module.exports = { { type: 'doc', id: 'github-cli/github-action', label: 'GitHub Action' }, ], }, + { + type: 'category', + label: 'Docker', + collapsible: true, + collapsed: true, + items: [ + { type: 'doc', id: 'docker/docker-images', label: 'GameCI Docker images for Unity' }, + { type: 'doc', id: 'docker/windows-docker-images', label: 'Windows docker images' }, + { + type: 'doc', + id: 'docker/customize-docker-images', + label: 'Customize GameCI Unity Docker images', + }, + { type: 'doc', id: 'docker/versions', label: 'Versions' }, + { type: 'doc', id: 'docker/custom-images', label: 'Custom Images' }, + ], + }, { type: 'category', label: 'Orchestrator', @@ -469,23 +486,6 @@ module.exports = { }, ], }, - { - type: 'category', - label: 'Docker', - collapsible: true, - collapsed: true, - items: [ - { type: 'doc', id: 'docker/docker-images', label: 'GameCI Docker images for Unity' }, - { type: 'doc', id: 'docker/windows-docker-images', label: 'Windows docker images' }, - { - type: 'doc', - id: 'docker/customize-docker-images', - label: 'Customize GameCI Unity Docker images', - }, - { type: 'doc', id: 'docker/versions', label: 'Versions' }, - { type: 'doc', id: 'docker/custom-images', label: 'Custom Images' }, - ], - }, { type: 'category', label: 'Troubleshooting', From 494b8fbc4b4faf5b8182df5f46d63ca624fe6a83 Mon Sep 17 00:00:00 2001 From: frostebite Date: Thu, 14 May 2026 23:10:47 +0100 Subject: [PATCH 5/5] docs: move CLI above CI platforms --- sidebars.js | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/sidebars.js b/sidebars.js index 1061d100..37a1d682 100644 --- a/sidebars.js +++ b/sidebars.js @@ -5,6 +5,23 @@ module.exports = { defaultSidebar: [ 'index', { type: 'doc', id: 'getting-started/index', label: 'Getting started' }, + { + type: 'category', + label: 'CLI', + collapsible: true, + collapsed: true, + link: { type: 'doc', id: 'github-cli/index' }, + items: [ + { type: 'doc', id: 'github-cli/build', label: 'Engine Commands' }, + { type: 'doc', id: 'github-cli/remote-builds', label: 'Orchestrate' }, + { + type: 'doc', + id: 'github-cli/configuration-and-plugins', + label: 'Configuration and Plugins', + }, + { type: 'doc', id: 'github-cli/github-action', label: 'GitHub Action' }, + ], + }, { type: 'category', label: 'CI Platforms', @@ -177,23 +194,6 @@ module.exports = { }, ], }, - { - type: 'category', - label: 'CLI', - collapsible: true, - collapsed: true, - link: { type: 'doc', id: 'github-cli/index' }, - items: [ - { type: 'doc', id: 'github-cli/build', label: 'Engine Commands' }, - { type: 'doc', id: 'github-cli/remote-builds', label: 'Orchestrate' }, - { - type: 'doc', - id: 'github-cli/configuration-and-plugins', - label: 'Configuration and Plugins', - }, - { type: 'doc', id: 'github-cli/github-action', label: 'GitHub Action' }, - ], - }, { type: 'category', label: 'Docker',