Skip to content

docs: group the docs sidebar into sections - #15164

Merged
lawrencecchen merged 1 commit into
mainfrom
feat-docs-nav-sections
Sep 28, 2026
Merged

lawrencecchen merged 1 commit into
mainfrom
feat-docs-nav-sections

Conversation

@lawrencecchen

@lawrencecchen lawrencecchen commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

The docs sidebar was a flat list of 20+ pages, with one "Agent Integrations" section. Related pages sat far apart, for example Browser Automation and Computer Use. This PR groups every page into seven sections:

  • Basics: Getting Started, Concepts, Keyboard Shortcuts
  • Workspaces: Workspace Groups, Session Restore, TextBox, Dock, Task Manager
  • Agents: Notifications, Skills, Vault, and the five agent integration pages
  • Automation: CLI Reference, Browser Automation, Computer Use
  • Remote Access: SSH, Remote tmux, cmux TUI, iOS App
  • cmux Cloud: Overview, Base (nightly docs only, as before), Machines, Workspaces and Agents, Files and Networking, Cloud CLI Reference, Security and Troubleshooting
  • Customize and Admin: Configuration, Custom Commands, Managed Policies

Changelog stays last, with no section.

All URLs are unchanged. Only the sidebar grouping and the previous/next pager order change. Per-locale visibility rules (locales, contentLocales) are kept on every link. The section labels are translated for all 20 locales. The old agentIntegrations label is removed, because nothing uses it now.

Verification

  • bun run typecheck and eslint on the nav file pass.
  • bun test for docs-search-index, docs-search-utils, docs-channel, seo, content-locale-link, and client-messages: 53 pass.
  • Local docs-zone render: the release sidebar in English and Japanese shows the seven sections in the order above. The nightly sidebar shows Base under cmux Cloud.

Changelog

  • Changed: the cmux.com docs sidebar groups pages into sections.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Documentation links are now grouped into sections for basics, workspaces, agents, automation, remote access, cloud, and customization, making topics easier to browse.
    • The changelog remains a top-level navigation link, and existing locale-specific link availability is unchanged.
    • Section labels are available across supported languages.
    • The “Agent Integrations” navigation item has been removed.

@coderabbitai

coderabbitai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: manaflow-ai/cmux/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 60061cd9-8f22-4ff2-bfe1-8be45f7ea806

📥 Commits

Reviewing files that changed from the base of the PR and between dcacaab and 3c3cd4a.

📒 Files selected for processing (21)
  • web/app/[locale]/components/docs-nav-items.ts
  • web/messages/ar.json
  • web/messages/bs.json
  • web/messages/da.json
  • web/messages/de.json
  • web/messages/en.json
  • web/messages/es.json
  • web/messages/fr.json
  • web/messages/it.json
  • web/messages/ja.json
  • web/messages/km.json
  • web/messages/ko.json
  • web/messages/no.json
  • web/messages/pl.json
  • web/messages/pt-BR.json
  • web/messages/ru.json
  • web/messages/th.json
  • web/messages/tr.json
  • web/messages/uk.json
  • web/messages/zh-CN.json
  • web/messages/zh-TW.json

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 1 remain after this review.


📝 Walkthrough

Walkthrough

The documentation navigation now groups links into named sections. Locale files add labels for the new sections and remove the Agent Integrations label.

Changes

Documentation navigation

Layer / File(s) Summary
Basics, workspaces, and agents
web/app/[locale]/components/docs-nav-items.ts
Groups basics, workspace, and agent documentation links. The task manager locale restriction remains.
Automation, remote, cloud, and customization
web/app/[locale]/components/docs-nav-items.ts
Adds groups for automation, remote access, cloud, and customization. The cloud group includes the base link. Existing locale restrictions remain.
Localized section labels
web/messages/*.json
Removes the Agent Integrations label and adds labels for the new navigation sections across locales.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: austinywang

Merge Risk: ⚪ Minimal · up to 3c3cd

The new Norwegian section label is localized, and the described changes reorganize the documentation navigation without establishing a remaining user-facing regression. No actionable merge-blocking risk remains.


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error, 1 warning)

Check name Status Explanation Resolution
Cmux Full Internationalization ❌ Error The PR adds locale-specific docs sidebar labels, but several new entries are copied English in non-English catalogs. web/app/[locale]/components/docs-sidebar.ts:75 renders each new sectionKey thro… Replace the copied English values with translations in web/messages/da.json, web/messages/es.json, web/messages/pt-BR.json, and web/messages/de.json. Keep the six new section keys present in every locale listed by `web/i18n/routing.…
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (20 skipped: 2… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (23 passed)
Check name Status Explanation
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.
Cmux Cloud Persistent Session And Early Input ✅ Passed PASS: The authoritative PR diff changes only the docs navigation definition and locale message labels. It does not change Cloud terminal creation, cmux-tui or transport lifecycle, renderer gating, inp…
Cmux Swift Actor Isolation ✅ Passed PASS: The review-scoped diff changes only one TypeScript file and 20 JSON locale files. It introduces no production Swift changes, so the Swift 6 actor-isolation failure conditions do not apply.
Cmux Swift Blocking Runtime ✅ Passed The pull request changes only one TypeScript navigation file and 20 locale JSON files. The review-scoped diff contains no Swift paths and no blocking-runtime constructs. The Swift-specific check is th…
Cmux Browser Automation Off-Main ✅ Passed PASS: The pull request changes only the documentation navigation TypeScript file and locale JSON files. The authoritative diff contains no changes to Sources/TerminalController.swift, `ControlComman…
Cmux Expensive Synchronous Load ✅ Passed The pull request changes only the web documentation navigation TypeScript file and locale JSON files. The authoritative diff contains no Swift files or production Swift changes, so the expensive synch…
Cmux Cache Substitution Correctness ✅ Passed The pull request changes a static TypeScript documentation navigation declaration and locale JSON labels. The diff contains no cache, persistence, history, undo, or snapshot read, and it does not repl…
Cmux No Hacky Sleeps ✅ Passed The PR changes only the documentation navigation structure and locale labels. The authoritative diff adds no sleep, timer, polling, retry, delay, or wall-clock synchronization logic, and the changed l…
Cmux Algorithmic Complexity ✅ Passed PASS. The PR changes only the static navItems layout in web/app/[locale]/components/docs-nav-items.ts and adds translation keys. It does not add scans, sorting, joins, batch actions, or hot-path c…
Cmux Swift Concurrency ✅ Passed PASS: The authoritative pull-request diff changes only one TypeScript file and 20 JSON locale files. It contains no Swift files or Swift concurrency changes, so the cmux Swift concurrency check is not…
Cmux Swift @Concurrent ✅ Passed PASS: The authoritative PR diff contains only one TypeScript file and 20 JSON locale files. It contains no Swift files or Swift isolation changes, so the @concurrent check is not applicable.
Cmux Swift Package Boundaries ✅ Passed The pull request changes only one TypeScript navigation file and 20 JSON locale files. The authoritative diff contains no Swift files, Package.swift files, or other Swift package changes, so the Swift…
Cmux Swiftpm Lockfiles ✅ Passed PASS: The authoritative PR diff changes only the docs navigation file and locale message JSON files. It changes no SwiftPM package, Xcode project, .gitignore, workflow, or dependency files, so the S…
Cmux Swift Logging ✅ Passed PASS: The pull request changes only one TypeScript file and locale JSON files. The authoritative diff contains no Swift, Objective-C, or Objective-C++ files, so it adds or materially changes no Swift …
Cmux User-Facing Error Privacy ✅ Passed PASS: The pull request changes the user-facing documentation sidebar and locale labels only. The diff adds section headings and reorders documentation links; it does not add or modify user-facing erro…
Cmux Swiftui State Layout ✅ Passed PASS: The pull request changes only one TypeScript docs navigation file and 20 JSON locale files. The authoritative diff contains no Swift or SwiftUI files, ObservableObject, @Published, GeometryReade…
Cmux Architecture Rethink ✅ Passed PASS: The pull request changes one TypeScript navigation file and 20 JSON locale files. It changes no Swift files and introduces no Swift timing, state-ownership, lifecycle, or bridge changes covered …
Cmux Swift Auxiliary Window Close Shortcuts ✅ Passed PASS: The pull request changes only the TypeScript docs navigation file and locale JSON files. The authoritative diff contains no Swift files and no auxiliary-window rule file changes, so the Swift au…
Cmux Source Artifacts ✅ Passed PASS. The PR changes one hand-written navigation source file and 20 localization catalogs. The diff contains no artifact directories, generated logs, screenshots, recordings, caches, build output, or …
Cmux No Test Or Debug Seam In Production Source ✅ Passed The pull request changes one TypeScript navigation file and 20 locale JSON files. The authoritative diff contains no Swift file under a production Sources/ path, so the no-test-or-debug-seam check d…
Title check ✅ Passed The title clearly and concisely describes the primary change: grouping the documentation sidebar into sections.
Description check ✅ Passed The description explains the problem, resulting sidebar structure, unchanged URLs, locale behavior, verification performed, and changelog entry. It uses a Verification heading instead of Testing and o…
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (20 skipped: 20 unsupported.)

Full details: Cmux Full Internationalization

Explanation

The PR adds locale-specific docs sidebar labels, but several new entries are copied English in non-English catalogs. web/app/[locale]/components/docs-sidebar.ts:75 renders each new sectionKey through useTranslations("docs.navItems"), so these values are user-facing. The diff adds workspacesSection: "Workspaces" in web/messages/da.json:1822, web/messages/es.json:1822, and web/messages/pt-BR.json:1822, plus workspacesSection: "Workspaces" and agentsSection: "Agents" in web/messages/de.json:1822-1823. Existing translated equivalents in the same catalogs, such as Danish cloudWorkspaces: "Arbejdsområder og agenter", Spanish cloudWorkspaces: "Espacios de trabajo y agentes", and Brazilian Portuguese cloudWorkspaces: "Espaços de trabalho e agentes", confirm these are untranslated additions rather than required product tokens. All 20 locale files contain the new keys, but these entries violate the rule against copied English translations.

Resolution

Replace the copied English values with translations in web/messages/da.json, web/messages/es.json, web/messages/pt-BR.json, and web/messages/de.json. Keep the six new section keys present in every locale listed by web/i18n/routing.ts, and verify each new value is a real locale translation rather than copied English.

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 2
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

Base automatically changed from feat-cloud-docs to main September 28, 2026 04:54
Basics, Workspaces, Agents (with the agent integrations), Automation,
Remote Access, cmux Cloud (now with Base), and Customize and Admin.
URLs are unchanged; only nav grouping and pager order change. Section
labels are translated for all 20 locales, and the unused
agentIntegrations label is removed.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@lawrencecchen
lawrencecchen merged commit 744176a into main Sep 28, 2026
78 of 94 checks passed
@lawrencecchen
lawrencecchen deleted the feat-docs-nav-sections branch September 28, 2026 05:06
@github-actions

Copy link
Copy Markdown
Contributor

Merge receipt for 3c3cd4ac96: every check was green at merge (20 verified; 17 skipped by policy). Full suite runs on main after merge.

rustybret pushed a commit to rustybret/bmux that referenced this pull request Sep 28, 2026
744176a docs: group the docs sidebar into sections (manaflow-ai#15164)
b4d72a9 Keep cmux's own keys out of the config error card; end restored scrollback on a new line (manaflow-ai#15152)
80dfbb3 zsh integration: use zsh/zselect for poll-loop sleeps (no fork) (manaflow-ai#6032)
426248d docs: stop table code cells wrapping per character (manaflow-ai#15165)
dcacaab docs: add cmux Cloud documentation section in all locales (manaflow-ai#15143)
10c4d52 Fix Mac discovery consent, live terminal resizing, and blank hibernated agents (manaflow-ai#14420)
55b4049 Keep Cloud sidebar drags free of hints (manaflow-ai#15123)
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.

1 participant