Skip to content

Comments

docs: Add exact slash commands to getting-started guide#1505

Merged
bmadcode merged 2 commits intobmad-code-org:mainfrom
thewoolleyman:docs/clarify-getting-started-commands
Feb 1, 2026
Merged

docs: Add exact slash commands to getting-started guide#1505
bmadcode merged 2 commits intobmad-code-org:mainfrom
thewoolleyman:docs/clarify-getting-started-commands

Conversation

@thewoolleyman
Copy link
Contributor

Summary

  • Adds the exact slash commands (e.g., /bmad-bmm-create-prd, /bmad-agent-bmm-pm) inline alongside every agent and workflow reference in the getting-started tutorial
  • Adds a short explanatory note after the installation section clarifying how slash commands and agents relate
  • Adds a Command column to the Quick Reference and Build Cycle tables
  • All existing prose is preserved — changes are purely additive

Motivation

The current getting-started guide says things like "Load the PM agent in a new chat" and "Run the prd workflow" 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

  • Verify all slash commands match the installed command names from bmad-help.csv
  • Confirm no existing prose was removed — only augmented

🤖 Generated with Claude Code

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>
@coderabbitai
Copy link

coderabbitai bot commented Feb 1, 2026

📝 Walkthrough

Walkthrough

The 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 /bmad-help, /bmad-brainstorming, /bmad-agent-bmm-pm, and /bmad-bmm-create-prd across analysis, planning, solutioning, and build phases. A new guidance note on loading agents and running workflows is also included.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/tutorials/getting-started.md
Added explicit slash-command examples throughout all workflow phases (analysis, planning, solutioning, build cycles). Introduced new guidance note on loading agents and running workflows. Updated Fresh Chats notes, Phase 1-3 sections, Epic/Stories, Sprint Planning, retrospectives, and Quick Reference table to include specific commands for each workflow step and agent loading. Minor wording consistency fixes for slash-command format.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • PR #1290: Renames create-tech-spec to quick-spec across workflows and documentation—directly modifies the same workflow/command names referenced in this PR.
  • PR #1396: Updates documentation to introduce explicit slash-commands and workflow guidance—modifies the same documentation area and command-driven workflow patterns.

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding explicit slash commands to the getting-started documentation guide.
Description check ✅ Passed The description clearly relates to the changeset, providing motivation and detailed summary of the slash command additions to the getting-started tutorial.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@alexeyv alexeyv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@bmadcode
Copy link
Collaborator

bmadcode commented Feb 1, 2026

Good idea here - thank you @thewoolleyman

@bmadcode bmadcode merged commit 981e5a4 into bmad-code-org:main Feb 1, 2026
bmadcode pushed a commit that referenced this pull request Feb 1, 2026
### 🎁 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
@thewoolleyman
Copy link
Contributor Author

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.

@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 !

@alexeyv
Copy link
Contributor

alexeyv commented Feb 3, 2026

@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!).

Oh wow, it's been a while :) Join BMAD Discord, Chad, it's a fun place at times.

dickymoore pushed a commit to dickymoore/BMAD-METHOD that referenced this pull request Feb 6, 2026
…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.
dickymoore pushed a commit to dickymoore/BMAD-METHOD that referenced this pull request Feb 6, 2026
### 🎁 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants