Repository navigation
Add customization examples library - #4246
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
📝 WalkthroughWalkthroughThis PR adds a customization examples library to cmux docs and web UI, introduces ChangesExamples Library for cmux Customization
🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
Caution Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional.
❌ Failed checks (1 error, 1 warning)
✅ Passed checks (14 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 |
Greptile SummaryThis PR adds a reusable customization examples library (
Confidence Score: 5/5Safe to merge — all changes are documentation, skill metadata, and static docs content with no modifications to runtime app logic. The PR adds a new reference file and updates docs/translations only. All seven examples advertised in the docs page are present in references/examples.md. Translation keys are complete in both locales. No logic, APIs, database schema, or Swift code is touched. No files require special attention. Important Files Changed
Reviews (2): Last reviewed commit: "Address customization examples review" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| # cmux Customization Examples | ||
|
|
||
| Use these examples as starting points. Merge only the relevant top-level keys | ||
| into the user's existing `cmux.json`, preserve unrelated sections, then run | ||
| `cmux reload-config` when available. | ||
|
|
||
| Prefer project-local `.cmux/cmux.json` for team workflows and global | ||
| `~/.config/cmux/cmux.json` for personal app preferences. |
There was a problem hiding this comment.
The docs page (web/app/[locale]/docs/skills/page.tsx) renders a table row for id: "docs-workspace" with full i18n strings in both en.json and ja.json (exampleDocsName, exampleDocsSurface, exampleDocsUse). SKILL.md also instructs agents to load this file for "reusable patterns" that now includes docs workspaces by implication. There is no "Docs workspace" section or JSON snippet anywhere in this file. When a user asks an agent to apply that preset, the agent will find nothing and either fabricate a config or report an error. Either add the missing example section or remove the docs-workspace row from the page and its translation keys.
| ## CI Watch | ||
|
|
||
| Use this when the user wants a repeatable place for GitHub Actions, CircleCI, | ||
| or release-monitoring commands. Prefer Dock controls for long-running monitors. | ||
|
|
||
| ```json | ||
| { | ||
| "controls": [ | ||
| { | ||
| "id": "gh-runs", | ||
| "title": "GitHub Runs", | ||
| "command": "gh run list --limit 10 && exec ${SHELL:-/bin/zsh} -l", | ||
| "cwd": ".", | ||
| "height": 260 | ||
| }, | ||
| { | ||
| "id": "feed", | ||
| "title": "Feed", | ||
| "command": "cmux feed tui --opentui", | ||
| "height": 260 | ||
| } | ||
| ] | ||
| } | ||
| ``` |
There was a problem hiding this comment.
The CI Watch JSON block has "controls" as its top-level key — the same format used by dock.json (compare the labeled .cmux/dock.json block in the Full-Stack Dev section). The file-level preamble says to "merge only the relevant top-level keys into the user's existing cmux.json", so an agent that follows those instructions will put controls into cmux.json rather than dock.json, where it will be silently ignored or cause a parse error. Add a .cmux/dock.json: label above the code fence, matching the pattern used in the Full-Stack Dev example.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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 `@docs/internal/skills-customization-ideas.md`:
- Around line 69-70: The two promotion guidance items overlap; update the
Examples Library text around the sentence referencing "Promote an example into
its own skill only after it has setup commands, validation, and safety rules
that are too detailed for `cmux-customization`" to either reference the existing
general "Promotion Rule" section or replace both with a single consolidated
Promotion guidance paragraph that uses the canonical phrasing (mentioning "setup
commands, validation, safety rules" and "that an agent would otherwise
rediscover") and cross-references `cmux-customization` as needed; ensure you
update the sentence in the Examples Library and the general Promotion Rule so
they are not duplicated but point to the same consolidated guidance.
- Around line 61-67: The Examples Library list references a "Docs workspace"
entry that doesn't exist in examples.md; either add a corresponding example to
examples.md named "Docs workspace" with the described components (docs dev
server, browser preview, markdown viewer) or remove the "Docs workspace" bullet
from the list in docs/internal/skills-customization-ideas.md; update whichever
file you choose (look for the list block containing "Worktree agents... Quick
agent buttons" and the examples.md file where examples are enumerated) so the
two files are consistent.
In `@skills/cmux-customization/references/examples.md`:
- Around line 210-271: The examples list is advertising a "Docs workspace"
preset that isn't present in the examples file; either add a corresponding JSON
snippet for the "Docs workspace" preset into this examples collection (following
the pattern used by "Quick Agent Buttons" and "CI Watch") or remove "Docs
workspace" from the surfaced examples list in the code that builds the UI;
specifically update the examples library entry for the "Docs workspace" preset
(or the array that lists surfaced examples) so the name and content are
consistent with the examples shown (refer to the example snippets named "Quick
Agent Buttons" and "CI Watch" for structure and the UI key
"surfaceTabBar"/"controls" usage).
In `@skills/cmux-customization/SKILL.md`:
- Around line 54-57: The backup commands unconditionally copy files and will
fail if a source is missing; update the snippet around stamp="$(date
+%Y%m%d-%H%M%S)" and the two cp invocations to guard each copy with a
file-existence check (e.g., test -f or [ -f ]) before running cp for
~/.config/cmux/cmux.json and .cmux/cmux.json so each backup only runs when the
corresponding file exists and still uses the stamp variable for the .bak
filename.
🪄 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: 9c2055c2-b46e-46a4-b110-1e0ae3d2e454
📒 Files selected for processing (7)
docs/internal/skills-customization-ideas.mdskills/cmux-customization/SKILL.mdskills/cmux-customization/agents/openai.yamlskills/cmux-customization/references/examples.mdweb/app/[locale]/docs/skills/page.tsxweb/messages/en.jsonweb/messages/ja.json
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Addressed by e3bab43; latest checks and bot summaries are green.
This branch was successfully deployed
1 participant
Summary
Testing
Note
Low Risk
Low risk: changes are limited to documentation, skill metadata, and localized strings/UI docs rendering with no runtime cmux behavior changes.
Overview
Adds an examples library to
cmux-customization, including a newreferences/examples.mdfile with copy/pasteable presets (worktree agents, full-stack dev, SSH devbox, PR review, docs workspace, CI watch, and quick agent buttons) plus a small validation checklist.Updates the
cmux-customizationskill docs and OpenAI metadata to point agents at the examples library, clarify project-local vs global precedence, and add a simple backup step before editing configs.Surfaces the examples library in the web Skills docs page via a new table and prompt snippets, with new
en/jatranslation strings, and expands internal planning notes around presets and promotion guidance.Reviewed by Cursor Bugbot for commit e3bab43. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by cubic
Added a reusable customization examples library for cmux and surfaced it in the Skills docs and the
cmux-customizationskill. This helps users quickly apply common workflows like worktrees, dev layouts, PR review, SSH, agent buttons, and CI.skills/cmux-customization/references/examples.mdwith seven JSON presets (worktree agents, full‑stack dev, SSH devbox, review PR, docs workspace, quick agent buttons, CI watch) and a validation checklist.skills/cmux-customization/SKILL.mdwith examples-library guidance, explicit config precedence (project overrides global), timestamped backup/rollback steps, and an Examples Library section.skills/cmux-customization/agents/openai.yamlto default to picking an examples preset and validatingcmux.json.web/app/[locale]/docs/skills/page.tsx, withen/jastrings.docs/internal/skills-customization-ideas.mdwith examples scope, config lifecycle, team/agent presets,ui.newWorkspace.contextMenu(and alias) guidance, and a refined Promotion Rule.Written for commit e3bab43. Summary will update on new commits. Review in cubic
Summary by CodeRabbit
Documentation
New Features