Interactive workflow guide, README Quick Start overhaul, and /bmad-help callouts#1396
Interactive workflow guide, README Quick Start overhaul, and /bmad-help callouts#1396bmadcode merged 11 commits intobmad-code-org:mainfrom
Conversation
Replace confusing static SVG workflow diagram with an interactive guide at /workflow-guide. Users select their track (Quick Flow, BMad Method, Enterprise) and see relevant phases, agents, commands, and outputs. Update link validator to recognize custom page routes. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Wrap create-story, dev-story, and code-review in a dashed border group with a "Repeat for each story" label to clearly communicate the iterative development cycle in Phase 4. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replace expandable phase cards with a clean vertical flow showing slash commands as the primary element, with down arrows between steps, agent badges, required/optional status, and concise descriptions. Add prominent /bmad-help callout and note that agent loading is optional. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replace wordy paragraphs and track table with two clear numbered paths (Quick Flow: 3 commands, BMad Method: 6 steps) and a prominent /bmad-help callout as the primary guidance mechanism. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add Party Mode bullet to Why BMad section, note about agent-based usage as an alternative to direct workflows, and a /bmad-help mention in the getting-started tutorial after installation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis PR updates documentation content and introduces a new interactive Workflow Guide component. Changes include updates to README and tutorial documentation, additions to the docs site navigation, new Astro page and component for interactive workflow visualization, and refinement of link validation tooling to skip custom page routes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 8: The tagline string containing "AI Driven Development" should be
changed to "AI-Driven Development" for grammatical consistency; locate the
sentence text "**Breakthrough Method of Agile AI Driven Development** — An
AI-driven agile development framework..." in README.md and replace the
unhyphenated phrase "AI Driven Development" with "AI-Driven Development" so it
matches the later usage "AI-driven".
| [](https://discord.gg/gk8jAdXWmj) | ||
|
|
||
| **Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. | ||
| **Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. |
There was a problem hiding this comment.
Hyphenate "AI-Driven" for grammatical consistency.
The tagline uses "AI-driven" later in the same sentence (correctly hyphenated). For consistency and proper compound adjective usage, "AI Driven Development" should be "AI-Driven Development".
Proposed fix
-**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
+**Breakthrough Method of Agile AI-Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. | |
| **Breakthrough Method of Agile AI-Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. |
🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: Use a hyphen to join words.
Context: ...XWmj) Breakthrough Method of Agile AI Driven Development — An AI-driven agil...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@README.md` at line 8, The tagline string containing "AI Driven Development"
should be changed to "AI-Driven Development" for grammatical consistency; locate
the sentence text "**Breakthrough Method of Agile AI Driven Development** — An
AI-driven agile development framework..." in README.md and replace the
unhyphenated phrase "AI Driven Development" with "AI-Driven Development" so it
matches the later usage "AI-driven".
The /workflow-guide absolute path breaks with non-root base paths. Use relative paths since workflow-guide is a custom Astro page outside the docs collection. Docs-to-docs links keep the /docs/ pattern which the rehype plugin handles. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Use /workflow-guide to match the /docs/ convention used throughout. Works correctly on the production site where base path is /. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Summary
/workflow-guide): A standalone Astro page with track selector (Quick Flow / BMad Method / Enterprise) showing a vertical flow of slash commands with descriptions, agent badges, required/optional status, and a visual dev loop indicator/bmad-helpcallout, Party Mode mention, and note about agent-based usage/bmad-helpmention after installation/workflow-guide)Test plan
/workflow-guidepage renders correctly with all three tracks🤖 Generated with Claude Code