docs: add cmux Cloud documentation in all locales - #15143
Merged
Merged
Conversation
Six pages under /docs/cloud (overview, machines, workspaces and agents, files and networking, CLI reference, security and troubleshooting), wired into docs nav, sitemap, agent page index, docs search aliases and the audited SEO matrix. Copy is checked against the CLI usage text and the enforced plan limits; translated into all 20 site locales. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Contributor
|
All contributors have signed the CLA ✍️ ✅ |
|
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 configurationConfiguration used: Repository: manaflow-ai/cmux/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (32)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughAdds six localized Cloud documentation pages covering setup, machines, workspaces, networking, CLI commands, and troubleshooting. Adds navigation, search, sitemap, and SEO entries for those pages, with translations across the message catalogs. ChangesCloud documentation
Priority: ➖ Normal Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to No actionable issue remains from this review; the Cloud documentation changes are mergeable after normal checks. Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error, 1 warning)
✅ Passed checks (23 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 7.69% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 13 functions across 12 files. (20 skipped: 20 unsupported.) Full details: Cmux Full InternationalizationExplanation The localized Cloud pages and all six new message namespaces have matching entries in all 20 locales. However, the PR adds six user-facing page titles as English literals in Resolution Replace the six literal
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
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. Comment |
Contributor
|
Merge receipt for |
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)
3 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
cmux.com had no Cloud documentation. This PR adds a cmux Cloud section with six pages, in all 20 site locales:
/docs/cloud: what a machine is, requirements, quickstart, the app UI and shortcuts, the CLI entry point, and the base machine./docs/cloud/machines: sizes, plan limits, resize, pause/resume, checkpoints/forks/restore, rename, status, delete, and what happens when a plan ends./docs/cloud/workspaces: durable terminals,vm agent/run/exec/dev, notifications, image paste, layouts, installed tools, model access, the guest CLI, and iPhone./docs/cloud/networking: push/pull, secret files, env vars, ports and the in-app browser, desktop, the private network, the optional system VPN, public URLs, and custom domains./docs/cloud/cli: everycmux vm/cmux cloud domains/cmux vpn/cmux ai-accountsverb./docs/cloud/troubleshooting: the security model and a table of common errors with fixes.The facts come from source, not from the older copy. Every CLI example was checked against the usage text in
CLI/. Sizes come fromweb/services/vms/images/sizes.ts, and limits frommachineSpec.ts/entitlements.ts(50 active machines per seat, no shared resource pool, no create on Free, 32g/64g only on Max). The docs say that machines do not pause when idle, becauseFREESTYLE_PERSISTENT_IDLE_TIMEOUT_SECONDS = -1. The docs leave out the flagged Go plan, dev-only env vars, hidden CLI verbs, and features that exist only as designs (.cmux/cloud.json, devcontainer).Known conflicts in existing copy, not fixed here: the pricing page still says Pro/Max resources are "shared across all VMs", and the compare table lists a Free Cloud VM size. Both contradict the enforced code.
The pages are wired into the docs nav (a new "cmux Cloud" section), the sitemap, the agent page index, the docs search aliases, and the audited SEO matrix in
tests/seo.test.ts, so every locale's title and description are length-checked.Verification
bun run typecheck, eslint on the changed files, andbun run lint:complexitypass.bun test tests/seo.test.ts tests/docs-search-index.test.ts tests/docs-search-utils.test.ts tests/client-messages.test.ts tests/content-locale-link.test.tsx tests/docs-channel.test.ts: 53 pass.bun run test: the only failure isvercel-ignore-build.test.ts("outside a shallow clone"). It fails the same way onmainin this checkout, and the change does not touch it.CMUX_DOCS_CHANNEL=release next dev): all six English pages and samples in ja, ar, km, de, zh-CN, and fr return 200 with localized titles and no raw message keys.Changelog
🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Summary by cubic
Adds cmux Cloud documentation to cmux.com in all 20 locales, covering six new pages under
/docs/cloud(overview, machines, workspaces, networking, CLI reference, and troubleshooting).Migration
cloudSection,cloudOverview,cloudMachines,cloudWorkspaces,cloudNetworking,cloudCli, andcloudTroubleshootingkeys to any locale file not covered here.Written for commit a9063c3. Summary will update on new commits.
Summary by CodeRabbit