Skip to content

docs: group CI platform docs under a shared sidebar section#573

Merged
frostebite merged 5 commits into
mainfrom
feat/organize-ci-platform-sections
May 15, 2026
Merged

docs: group CI platform docs under a shared sidebar section#573
frostebite merged 5 commits into
mainfrom
feat/organize-ci-platform-sections

Conversation

@frostebite
Copy link
Copy Markdown
Member

@frostebite frostebite commented May 14, 2026

image

Summary

  • group the CI-platform-specific docs under a new top-level CI Platforms sidebar section
  • keep Docker, GitHub CLI, GitHub Orchestrator, troubleshooting, and FAQ as separate top-level sections
  • preserve existing doc paths and URLs by changing sidebar structure only

Verification

  • yarn build
  • yarn test

Notes

  • Build still reports the existing duplicate route warning for /docs/docker/versions; this PR does not change that route

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation sidebar with explicit platform-specific sections (GitHub, GitLab, CircleCI, Self-Hosting) and nested categories for improved navigation and content discoverability.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

📝 Walkthrough

Walkthrough

This PR restructures the Docusaurus sidebars.js configuration from a single autogenerated root directory to an explicitly organized hierarchy. The new structure introduces CI platform sections (GitHub, GitLab, CircleCI, Self-Hosting) with nested categories for deployment and self-hosting provisioning, while preserving autogenerated entries for specific documentation directories.

Changes

Documentation Sidebar Restructuring

Layer / File(s) Summary
Explicit CI Platform and Hosting Sidebar Organization
sidebars.js
The sidebar configuration replaces autogenerated root directory coverage with an explicit hierarchy organizing documentation by CI platform (GitHub as default, plus GitLab, CircleCI, Self-Hosting), each with nested Deployment categories. Self-Hosting includes further nesting for Host Creation, Provisioning, Runner Installation, and Windows Runner Setup. Autogenerated entries are preserved for CLI, Orchestrator, Docker, Troubleshooting, and FAQ directories.

🎯 2 (Simple) | ⏱️ ~12 minutes

A rabbit hops through the docs with glee,
Organizing platforms—GitHub, GitLab, and CI,
Self-hosting paths now crystal and clear,
No more autogenerated chaos here! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description includes a summary of changes and verification steps, but lacks clear sections matching the required template structure with explicit Changes, Checklist, and acknowledgment items. Restructure the description to explicitly follow the template format with a 'Changes' section listing modifications and a 'Checklist' section with the required items checked off.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly and specifically describes the main change: grouping CI platform documentation under a shared sidebar section, which aligns with the core objective of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/organize-ci-platform-sections

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

Cat Gif

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

Visit the preview URL for this PR (updated for commit 494b8fb):

https://game-ci-5559f--pr573-feat-organize-ci-pla-zaqcsczg.web.app

(expires Thu, 21 May 2026 22:13:43 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b

@frostebite frostebite enabled auto-merge (squash) May 14, 2026 22:47
@frostebite frostebite merged commit 2d3a558 into main May 15, 2026
9 checks passed
@frostebite frostebite deleted the feat/organize-ci-platform-sections branch May 15, 2026 00:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants