Skip to content

Commit 999ece3

Browse files
forcetrainerclaude
andauthored
Interactive workflow guide, README Quick Start overhaul, and /bmad-help callouts (#1396)
* Add interactive workflow guide page 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> * Add visual dev loop indicator to workflow guide 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> * Simplify workflow guide to vertical slash command flow 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> * Simplify README Quick Start with numbered command flows 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 to README, /bmad-help to getting-started 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> * Add link to getting-started tutorial in README Quick Start Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add workflow guide link to docs index New Here section Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Update README tagline and format modules table Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix workflow-guide links to use relative paths 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> * Revert workflow-guide links to absolute paths 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> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent baf2b9d commit 999ece3

6 files changed

Lines changed: 501 additions & 21 deletions

File tree

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
66
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
77

8-
**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.
8+
**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.
99

1010
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
1111

@@ -16,6 +16,7 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
1616
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
1717
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
1818
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
19+
- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively
1920
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
2021

2122
## Quick Start
@@ -26,34 +27,43 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
2627
npx bmad-method@alpha install
2728
```
2829

29-
Follow the installer prompts to configure your project.
30+
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
3031

31-
Once you have installed BMad to a folder, launch your tool of choice from where you installed BMad. (We really like Claude Code and Cursor - but there are any that work great with BMad!)
32+
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like `/bmad-help How should I build a web app for XYZ?`
3233
33-
Then its simple as running the command: `/bmad-help` if you do not know what to do. Depending on which modules you have installed, you will have different choices.
34+
The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.
3435

35-
To make the help more applicable you can even run the `/bmad-help What do you suggest I do to get started building a brand new web application for XYZ`.
36+
### Simple Path (Quick Flow)
3637

37-
The results from BMad Help will be able to suggest and constantly guide you on what to do next - along with the workflows upon completion also making suggestions on what to do next.
38+
Bug fixes, small features, clear scope — 3 commands:
3839

39-
This analyzes your project and recommends a track:
40+
1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories
41+
2. `/dev-story` — implements each story
42+
3. `/code-review` — validates quality
4043

41-
| Track | Best For | Time to First Story Coding |
42-
| --------------- | ------------------------- | -------------------------- |
43-
| **Quick Flow** | Bug fixes, small features | ~10-30 minutes |
44-
| **BMad Method** | Products and platforms | ~30 minutes - 2 hours |
45-
| **Enterprise** | Compliance-heavy systems | ~1-3 hours |
44+
### Full Planning Path (BMad Method)
45+
46+
Products, platforms, complex features — structured planning then build:
47+
48+
1. `/product-brief` — define problem, users, and MVP scope
49+
2. `/create-prd` — full requirements with personas, metrics, and risks
50+
3. `/create-architecture` — technical decisions and system design
51+
4. `/create-epics-and-stories` — break work into prioritized stories
52+
5. `/sprint-planning` — initialize sprint tracking
53+
6. **Repeat per story:** `/create-story``/dev-story``/code-review`
54+
55+
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask `/bmad-help` anytime. For a detailed walkthrough, see the [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/).
4656

4757
## Modules
4858

4959
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time.
5060

51-
| Module | GitHub | NPM | Purpose |
52-
|--------|--------|-----|---------|
53-
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
54-
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
55-
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
56-
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
61+
| Module | GitHub | NPM | Purpose |
62+
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
63+
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
64+
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
65+
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
66+
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
5767

5868
## Documentation
5969

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ If you're comfortable working with AI coding assistants like Claude, Cursor, or
1313
The fastest way to understand BMad is to try it. Choose a tutorial to walk through your first project in about 10 minutes.
1414

1515
- **[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Latest features, still in active development
16+
- **[Workflow Guide](/workflow-guide)** — A simple visual overview of the various BMad tracks that get you going quickly.
1617

1718
:::tip[Already familiar with AI-assisted development?]
1819
Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md) to understand how BMad organizes its AI personas.

docs/tutorials/getting-started/getting-started-bmadv6.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,7 @@ BMad helps you build software through guided workflows with specialized AI agent
4242
| 3 | Solutioning | Design architecture *(BMad Method/Enterprise only)* |
4343
| 4 | Implementation | Build epic by epic, story by story |
4444

45-
![BMad Method Workflow - Standard Greenfield](./images/workflow-method-greenfield.svg)
46-
47-
*Complete visual flowchart showing all phases, workflows, and agents for the standard greenfield track.*
45+
**[Open the Interactive Workflow Guide](/workflow-guide)** to explore phases, agents, and outputs for your chosen track.
4846

4947
Based on your project's complexity, BMad offers three planning tracks:
5048

@@ -86,6 +84,8 @@ your-project/
8684
Having issues? See [Install BMad](/docs/how-to/installation/install-bmad.md) for common solutions.
8785
:::
8886

87+
Open your AI IDE in the project folder. From here, you can run `/bmad-help` anytime to see what to do next — or ask it a question like `/bmad-help How should I build a web app for XYZ?`
88+
8989
## Step 1: Initialize Your Project
9090

9191
Load the **Analyst agent** in your IDE, wait for the menu, then run `workflow-init`.

tools/validate-doc-links.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ const LINK_REGEX = /\[([^\]]*)\]\((\/[^)]+)\)/g;
2727
// File extensions that are static assets, not markdown docs
2828
const STATIC_ASSET_EXTENSIONS = ['.zip', '.txt', '.pdf', '.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp', '.ico'];
2929

30+
// Custom Astro page routes (not part of the docs content collection)
31+
const CUSTOM_PAGE_ROUTES = new Set(['/workflow-guide']);
32+
3033
// Regex to extract headings for anchor validation
3134
const HEADING_PATTERN = /^#{1,6}\s+(.+)$/gm;
3235

@@ -210,6 +213,11 @@ function processFile(filePath) {
210213
continue;
211214
}
212215

216+
// Skip custom Astro page routes
217+
if (CUSTOM_PAGE_ROUTES.has(linkPath)) {
218+
continue;
219+
}
220+
213221
// Validate the link target exists
214222
const targetFile = resolveLink(linkPath);
215223

0 commit comments

Comments
 (0)