Skip to content

Interactive workflow guide, README Quick Start overhaul, and /bmad-help callouts#1396

Merged
bmadcode merged 11 commits intobmad-code-org:mainfrom
forcetrainer:main
Jan 24, 2026
Merged

Interactive workflow guide, README Quick Start overhaul, and /bmad-help callouts#1396
bmadcode merged 11 commits intobmad-code-org:mainfrom
forcetrainer:main

Conversation

@forcetrainer
Copy link
Copy Markdown
Contributor

Summary

  • Interactive Workflow Guide (/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
  • README Quick Start overhaul: Replace wordy paragraphs and track table with two clear numbered command paths (3 commands for Quick Flow, 6 steps for BMad Method), prominent /bmad-help callout, Party Mode mention, and note about agent-based usage
  • Getting-started tutorial: Add /bmad-help mention after installation
  • Docs index: Add workflow guide link to "New Here?" section
  • Link validator: Support custom Astro page routes (/workflow-guide)
  • README tagline: Updated to "Breakthrough Method of Agile AI Driven Development"

Test plan

  • All pre-commit hooks pass (lint, markdownlint, tests, format, link validation, full Astro build)
  • Verify /workflow-guide page renders correctly with all three tracks
  • Verify track switching shows/hides correct steps
  • Verify dev loop visual indicator displays properly
  • Verify dark and light mode both work
  • Verify responsive layout on mobile

🤖 Generated with Claude Code

forcetrainer and others added 8 commits January 23, 2026 21:34
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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 24, 2026

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Documentation Updates
README.md, docs/index.md, docs/tutorials/getting-started/getting-started-bmadv6.md
Replaces tagline, adds "Party Mode" feature bullet, expands Quick Start narrative with /bmad-help reference, reorganizes Modules table with expanded descriptions, adds "Not sure what to do?" prompt, updates help path section to structured workflow, and adds navigation link to workflow guide tutorial.
Link Validation Tooling
tools/validate-doc-links.js
Introduces CUSTOM_PAGE_ROUTES constant containing /workflow-guide to skip validation for specified site-relative links during resolution and processing.
Workflow Guide Component
website/src/components/WorkflowGuide.astro, website/src/pages/workflow-guide.astro
Adds new interactive Astro page and component rendering a three-track selector (Quick Flow, BMad Method, Enterprise) with multi-phase flow visualization, status indicators, and JavaScript event handlers for track selection and visibility toggling.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
  • alexeyv
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the three main changes: interactive workflow guide, README Quick Start overhaul, and /bmad-help callouts.
Description check ✅ Passed The description is comprehensive and directly related to the changeset, covering the interactive workflow guide, README updates, documentation changes, and link validator modifications.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 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
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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".

[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
**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".

forcetrainer and others added 3 commits January 24, 2026 11:22
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>
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.

2 participants