docs: Add exact slash commands to getting-started guide#1505
Conversation
The getting-started tutorial referenced agents and workflows by name (e.g., "Load the PM agent", "Run the prd workflow") without providing the actual commands to type. This adds the exact slash commands inline alongside the existing prose so new users know precisely what to run. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThe PR updates the getting-started.md documentation to replace generic workflow references with explicit slash-command examples throughout all workflow phases. Changes include adding specific commands like Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 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 |
alexeyv
left a comment
There was a problem hiding this comment.
There is a bit of a problem here:
- Not all platforms have slash commands that are invoked like in Claude
- Not all platforms have agents installed at all
- /bmad-agent-bmm prefix has changed multiple times in the past. It will probably change more in the future
- Not all platform use those prefixes
- Workflows are referred in agent menus by names without the prefix.
- Workflows do not automatically load agent prompts.
If there is evidence that what's already there is not clear enough, adding a note that clearly states "if you are on Claude Code this is how you do it, if you are on something else, you have to figure it out yourself" may well be a good idea. Using exact slash command names throughout this document, in my opinion, isn't. Unless there is evidence to the contrary.
|
Good idea here - thank you @thewoolleyman |
### 🎁 Features * Add generate-project-context workflow * Shard market research customer analysis ### 🐛 Bug Fixes * Fix npm install peer dependency issues (PR #1476) * Fix leaked source paths in PRD validation report (#1481) * Fix orphaned market research customer analysis (#1486) * Fix duplicate 2-letter brainstorming code (BS → BSP) * Fix tech writer sidecar functionality (#1487) * Fix relative paths in workflow steps (#1497, #1498) * Fix party-mode workflow file extension (#1499) * Fix generated slash commands (#1501) * Fix agent scan and help CSV files * Fix HELP_STEP placeholder replacement (#1437) ### 📚 Documentation * Add exact slash commands to Getting Started guide (#1505) * Remove .claude/commands from version control (#1506) ### 🔧 Maintenance * Update Starlight to 0.37.5 * Add GitHub issue templates
@alexeyv Hi! (Fancy meeting you here, we know each other, we've chatted CruiseControl.rb and guitars in the past, like 15+ years ago - time flies!). Anyway, these are good points, especially about other tools not supporting slash commands. However, that makes them painful to use in general, and they are more of the edge case (and will probably eventually support slash commands anyway). I think that in this case, helping the onboarding experience for the new user outweighs these downsides. Thanks for merging @bmadcode ! |
Oh wow, it's been a while :) Join BMAD Discord, Chad, it's a fun place at times. |
…g#1505) The getting-started tutorial referenced agents and workflows by name (e.g., "Load the PM agent", "Run the prd workflow") without providing the actual commands to type. This adds the exact slash commands inline alongside the existing prose so new users know precisely what to run.
### 🎁 Features * Add generate-project-context workflow * Shard market research customer analysis ### 🐛 Bug Fixes * Fix npm install peer dependency issues (PR bmad-code-org#1476) * Fix leaked source paths in PRD validation report (bmad-code-org#1481) * Fix orphaned market research customer analysis (bmad-code-org#1486) * Fix duplicate 2-letter brainstorming code (BS → BSP) * Fix tech writer sidecar functionality (bmad-code-org#1487) * Fix relative paths in workflow steps (bmad-code-org#1497, bmad-code-org#1498) * Fix party-mode workflow file extension (bmad-code-org#1499) * Fix generated slash commands (bmad-code-org#1501) * Fix agent scan and help CSV files * Fix HELP_STEP placeholder replacement (bmad-code-org#1437) ### 📚 Documentation * Add exact slash commands to Getting Started guide (bmad-code-org#1505) * Remove .claude/commands from version control (bmad-code-org#1506) ### 🔧 Maintenance * Update Starlight to 0.37.5 * Add GitHub issue templates
Summary
/bmad-bmm-create-prd,/bmad-agent-bmm-pm) inline alongside every agent and workflow reference in the getting-started tutorialMotivation
The current getting-started guide says things like "Load the PM agent in a new chat" and "Run the
prdworkflow" without telling users the actual command to type. For someone new to BMAD, this is confusing — they have to hunt through other docs to figure out that the command is/bmad-bmm-create-prd. This PR adds the exact commands inline so users can follow the tutorial without guesswork.Test plan
bmad-help.csv🤖 Generated with Claude Code