Repository navigation
Lead homepage with a CLI link, rename API Reference to CLI Reference - #4990
Merged
Merged
Conversation
The homepage subtitle now ends "a CLI for programmability", with CLI linking to /docs/api. Rename the doc page title, sidebar nav, and related-doc label from "API Reference" to "CLI Reference" across all 20 locales. Keep the /docs/api URL (no slug change, so no 301s or lost backlinks) and keep the dual "cmux CLI and Unix socket API reference" meta description plus the socket API body content, so the page still ranks for both CLI and API queries. Add CLI aliases to the in-site search index. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR replaces "API Reference" with "CLI Reference" across navigation data, all locale message files, and search aliases, and updates the homepage subtitle to render a rich ChangesAPI to CLI Rebranding
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
Caution Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional.
❌ Failed checks (1 error, 1 warning)
✅ Passed checks (16 passed)
✨ Finishing Touches📝 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
Greptile SummaryThis PR reframes the cmux homepage around the CLI by adding a linked "CLI" anchor in the subtitle and renames the docs section from "API Reference" to "CLI Reference" across all surfaces, while keeping the
Confidence Score: 5/5Safe to merge — changes are limited to copy, i18n strings, an internal link, and search aliases with no routing, auth, or runtime logic touched. All 20 locales in routing.ts are updated, the t.rich pattern and cliLink component follow an already-established convention in the codebase, and the /docs/api URL is unchanged. No logic paths are affected. No files require special attention. Important Files Changed
Reviews (2): Last reviewed commit: "Make docs.api metaTitle match title in e..." | Re-trigger Greptile |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@web/messages/es.json`:
- Line 754: Update the Spanish localization string for the docs API meta title:
change the value of the JSON key docs.api.metaTitle from "Referencia CLI" to
"Referencia de CLI" so it matches the enforced locale copy; locate the entry
with the key docs.api.metaTitle in the es.json messages file and replace the
current value accordingly.
In `@web/messages/km.json`:
- Line 754: Update the Khmer locale entry for docs.api.metaTitle so it uses the
same label string as the other CLI Reference occurrences in this file (match the
text used at the other keys around lines where the CLI Reference appears);
locate the docs.api.metaTitle key in web/messages/km.json and replace its value
to exactly match the CLI Reference label used elsewhere to ensure consistency
with the locale registry and routing (reference key: docs.api.metaTitle and
existing CLI Reference entries in the same file).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 11cfedd2-8e7f-4dfd-96b4-99cd348431fc
📒 Files selected for processing (23)
web/app/[locale]/page.tsxweb/app/lib/agent-page-paths.tsweb/messages/ar.jsonweb/messages/bs.jsonweb/messages/da.jsonweb/messages/de.jsonweb/messages/en.jsonweb/messages/es.jsonweb/messages/fr.jsonweb/messages/it.jsonweb/messages/ja.jsonweb/messages/km.jsonweb/messages/ko.jsonweb/messages/no.jsonweb/messages/pl.jsonweb/messages/pt-BR.jsonweb/messages/ru.jsonweb/messages/th.jsonweb/messages/tr.jsonweb/messages/uk.jsonweb/messages/zh-CN.jsonweb/messages/zh-TW.jsonweb/tools/build-docs-search.mjs
The API->CLI token swap carried over a pre-existing mismatch where metaTitle used a different word form than the page title in these locales. The SEO title and the H1 describe the same page, so align them. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lawrencecchen
dismissed
coderabbitai[bot]’s stale review
May 29, 2026 22:36
Addressed in fe6bc0a: docs.api.metaTitle now matches the page title in es and km (and bs, tr). Both flagged threads are resolved.
Merged
This was referenced Jun 20, 2026
This branch was successfully deployed
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.
Reframes the homepage around the CLI and renames the docs "API Reference" to "CLI Reference".
Homepage
The subtitle's trailing clause changes from
and a socket API for automation.toand a CLI for programmability., with CLI linking to https://cmux.com/docs/api (rendered viat.rich, matching the existingcliLinkpattern in the FAQ).Rename
API ReferencebecomesCLI Referencein the doc page title, sidebar nav, related-docs link, andagent-page-paths(drives/docs/api.md+.txt). Applied across all 20 locales.SEO
/docs/apiso there are no 301s and no lost backlinks. The page legitimately documents the socket API too, so the slug is still accurate.metaDescriptionis left untouched (cmux CLI and Unix socket API reference...) and the socket/JSON-RPC body content stays, so the page keeps ranking for both CLI and API queries while the<title>now leads with the more-searched "CLI" term.CLI reference/cmux CLI/command linealiases to the in-site (pagefind) search index.Translations needing a native eyeball
The four label keys are a mechanical
APItoCLItoken-swap (e.g.Référence APItoRéférence CLI,APIリファレンスtoCLIリファレンス). The subtitle clause was hand-translated per locale (reusing each existing sentence, swapping only the final clause, keepingCLIas the Latin anchor). Please sanity-check these:arbsdadeenesfritjakmkonoplpt-BRruthtrukzh-CNzh-TW🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmithwith what you need. Autofix is disabled.Note
Low Risk
Copy, i18n, and search-index updates only; no routing, auth, or runtime behavior changes beyond new internal links and labels.
Overview
The homepage hero subtitle now ends with a CLI link to
/docs/apiviat.richand<cliLink>, replacing the old “socket API for automation” wording in every locale.Across 20 locale message files, user-facing API Reference labels become CLI Reference (docs page title/meta, sidebar
apiReference, skillsrelatedApi).agent-page-pathsuses the same title for agent-readable/docs/apiexports./docs/apiURL and meta descriptions are unchanged; socket/API doc body content stays.Pagefind search aliases gain
CLI reference,cmux CLI, andcommand line(alongside existing API/socket terms).Reviewed by Cursor Bugbot for commit fe6bc0a. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by cubic
Lead the homepage with a linked CLI and rename “API Reference” to “CLI Reference” across the app to emphasize the CLI. Keep
/docs/apiand API content unchanged while improving findability.New Features
cliLinkto/docs/api.agent-page-paths, and SEO title (metaTitle) across locales; fixed title/metaTitle mismatches ines,km,bs, andtr.SEO
/docs/apislug and meta description unchanged to preserve backlinks and dual (CLI + socket API) relevance.Written for commit fe6bc0a. Summary will update on new commits.
Review in cubic
Summary by CodeRabbit
New Features
Documentation