Refactor command syntax in README.md to use colon namespacing for consistency#26
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (2)
WalkthroughStandardized README command syntax to slash-prefixed Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (1)
121-124: Consider explaining the command format mechanism.Line 121 states the format "works in both Cursor and Claude Code" but doesn't explain why or how this colon-namespaced syntax achieves cross-environment compatibility. Users transitioning from the old
@workflow/commands/...syntax might benefit from a brief explanation.📝 Suggested clarification
-Invoke a workflow command (works in both Cursor and Claude Code): +Invoke workflow commands using colon-namespaced syntax (works in both Cursor and Claude Code): - `/bugfix:assess`, `/bugfix:diagnose`, `/bugfix:fix`, ... - `/docs-writer:gather`, `/docs-writer:plan`, `/docs-writer:draft`, ...Alternatively, you could add a brief note explaining that this syntax is recognized by both environments' command dispatchers, unlike the previous environment-specific formats.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 121 - 124, The README mentions the colon-namespaced commands like `/bugfix:assess` and `/docs-writer:plan` but doesn't explain how they work across Cursor and Claude Code; add a short clarification that this colon syntax is recognized by both environments' command dispatchers (unified command format) and contrasts it with the older `@workflow/commands/...` environment-specific form so readers understand that `/namespace:action` is the cross-environment mechanism and will be routed by both Cursor and Claude Code command handlers.ai-ready/README.md (1)
7-7: Inconsistent command format in prose.Line 7 uses "The
/updatecommand" while line 16 documents the full form/ai-ready:update. For consistency with other workflow READMEs (cve-fix, triage), prose and section headers typically use either the bare command name or describe it as a "phase" rather than including the slash prefix.📝 Suggested alignment options
Option 1 (matches cve-fix/triage pattern):
-The `/update` command scans a codebase and: +The `update` command scans a codebase and:Option 2 (more explicit):
-The `/update` command scans a codebase and: +The update phase scans a codebase and:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@ai-ready/README.md` at line 7, The README uses two different command formats (`/update` vs `/ai-ready:update`); pick a single style and make the prose consistent by replacing the `/update` occurrence with the bare workflow name ai-ready:update (remove the leading slash) and ensure headers and other references use the same form (or consistently refer to it as the "update phase") so the file matches the cve-fix/triage README pattern.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 21: Update the README "Design" workflow sentence to explicitly map each
high-level action to its phase/command names: append the command names in
parentheses for each step (e.g., "draft a technical design document (/draft)",
"decompose work into Jira-ready epics and stories (/decompose)", "manage review
via GitHub PRs (/revise)"), and add the missing phases for publishing and
handling responses by mentioning "/publish" and "/respond" for publishing final
outputs and responding to follow-ups; edit the line that currently begins with
"**Design** -- Design-and-decompose workflow" to include these command
annotations so all seven phases (/ingest, /draft, /decompose, /revise, /publish,
/respond, /sync) are explicitly referenced.
---
Nitpick comments:
In `@ai-ready/README.md`:
- Line 7: The README uses two different command formats (`/update` vs
`/ai-ready:update`); pick a single style and make the prose consistent by
replacing the `/update` occurrence with the bare workflow name ai-ready:update
(remove the leading slash) and ensure headers and other references use the same
form (or consistently refer to it as the "update phase") so the file matches the
cve-fix/triage README pattern.
In `@README.md`:
- Around line 121-124: The README mentions the colon-namespaced commands like
`/bugfix:assess` and `/docs-writer:plan` but doesn't explain how they work
across Cursor and Claude Code; add a short clarification that this colon syntax
is recognized by both environments' command dispatchers (unified command format)
and contrasts it with the older `@workflow/commands/...` environment-specific
form so readers understand that `/namespace:action` is the cross-environment
mechanism and will be routed by both Cursor and Claude Code command handlers.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 077b4011-ca2f-4e98-a6f6-ed87749acddf
📒 Files selected for processing (4)
README.mdai-ready/README.mdcve-fix/README.mdtriage/README.md
adalton
left a comment
adalton
left a comment
There was a problem hiding this comment.
Individual workflow READMEs now have stale descriptions
The root README expands several workflow descriptions but the individual README files weren't updated to match:
prd/README.md:3still says "...and manages review via GitHub PRs"design/README.md:3still says "...takes a PRD...breaks work into Jira-ready epics and stories, and manages review via GitHub PRs"
These now diverge from the more detailed descriptions in the root README.
2 participants
This pull request updates the documentation for several workflows to clarify feature descriptions and standardize command usage instructions across different environments. The main focus is on making the documentation more concise, accurate, and consistent, especially regarding how to invoke workflow commands in both Cursor and Claude Code environments.
Documentation improvements:
README.mdto clarify the steps and features for Bugfix, PRD, Design, and CVE Fix workflows, including new phases and automation details.Command usage standardization:
/workflow:command) that works in both Cursor and Claude Code, replacing previous environment-specific examples and references.These changes make the documentation easier to follow and ensure users can quickly understand and use the workflows in their preferred environment.
Summary by CodeRabbit
/bugfix:assess,/cve-fix:patch,/ai-ready:update) and removed separate Cursor/Claude Code instruction blocks.