diff --git a/docs/tutorials/getting-started/getting-started-bmadv6.md b/docs/tutorials/getting-started/getting-started-bmadv6.md index ed674cb3..8fd914d0 100644 --- a/docs/tutorials/getting-started/getting-started-bmadv6.md +++ b/docs/tutorials/getting-started/getting-started-bmadv6.md @@ -42,9 +42,7 @@ BMad helps you build software through guided workflows with specialized AI agent | 3 | Solutioning | Design architecture *(BMad Method/Enterprise only)* | | 4 | Implementation | Build epic by epic, story by story | -![BMad Method Workflow - Standard Greenfield](./images/workflow-method-greenfield.svg) - -*Complete visual flowchart showing all phases, workflows, and agents for the standard greenfield track.* +**[Open the Interactive Workflow Guide](/workflow-guide)** to explore phases, agents, and outputs for your chosen track. Based on your project's complexity, BMad offers three planning tracks: diff --git a/tools/validate-doc-links.js b/tools/validate-doc-links.js index 5b0a018a..55b23fd7 100644 --- a/tools/validate-doc-links.js +++ b/tools/validate-doc-links.js @@ -27,6 +27,9 @@ const LINK_REGEX = /\[([^\]]*)\]\((\/[^)]+)\)/g; // File extensions that are static assets, not markdown docs const STATIC_ASSET_EXTENSIONS = ['.zip', '.txt', '.pdf', '.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp', '.ico']; +// Custom Astro page routes (not part of the docs content collection) +const CUSTOM_PAGE_ROUTES = new Set(['/workflow-guide']); + // Regex to extract headings for anchor validation const HEADING_PATTERN = /^#{1,6}\s+(.+)$/gm; @@ -210,6 +213,11 @@ function processFile(filePath) { continue; } + // Skip custom Astro page routes + if (CUSTOM_PAGE_ROUTES.has(linkPath)) { + continue; + } + // Validate the link target exists const targetFile = resolveLink(linkPath); diff --git a/website/src/components/WorkflowGuide.astro b/website/src/components/WorkflowGuide.astro new file mode 100644 index 00000000..b8c020aa --- /dev/null +++ b/website/src/components/WorkflowGuide.astro @@ -0,0 +1,515 @@ +--- +--- + +
+
+

Select Your Track

+
+ + + +
+
+ +
+

Choose a track above to see the recommended workflow.

+ + +
+ +
+

Explore and validate your idea before committing to a plan. Use these workflows when starting fresh or when requirements are unclear.

+
+
+
+ Agent: Analyst + brainstorm-project +
+

A guided ideation session that takes your project idea and uses 60+ techniques to create brainstorm notes.

+
+
+
+ Agent: Analyst + research +
+

Conducts market, technical, or competitive research on your questions and produces a structured research document.

+
+
+
+ Agent: Analyst + product-brief + +
+

Combines your brainstorm and research notes into a strategic foundation document — product-brief.md — covering problem statement, target users, and MVP scope.

+
+
+
+
+ + +
+ +
+

Define what to build and why. Your track determines the planning workflow — Quick Flow uses a streamlined tech-spec, while BMad Method and Enterprise create a full PRD.

+
+
+
+ Agent: Barry (Solo Dev) + quick-spec +
+

Analyzes your project context and codebase, auto-detects your stack, and produces tech-spec.md with implementation-ready story files in one step.

+
+
+
+ Agent: PM + create-prd +
+

Uses your product brief (if available) to create PRD.md with user personas, requirements, success metrics, and risks.

+
+
+
+ Agent: UX Designer + create-ux-design + +
+

Uses your PRD or tech-spec to create ux-design.md with user journeys, wireframes, and a design system.

+
+
+
+
+ + +
+ +
+

Make technical decisions explicit, then break work into epics and stories informed by those decisions. Architecture must come before story creation.

+
+
+
+ Agent: Architect + create-architecture +
+

Uses your PRD to design the system architecture, producing architecture.md with ADRs covering data, API, security, and deployment decisions.

+
+
+
+ Agent: PM + create-epics-and-stories +
+

Combines your PRD and architecture to break work into epic files with prioritized, technically-informed stories.

+
+
+
+ Agent: Architect + implementation-readiness + +
+

Reviews all Phase 2-3 outputs to validate cohesion and produces a gate check report confirming you're ready to build.

+
+
+
+
+ + +
+ +
+

Build one story at a time through a repeating cycle. Complete each story's full lifecycle (dev + review) before starting the next. Use a fresh chat for each workflow run.

+
+
+
+ Agent: SM + sprint-planning + +
+

Uses your epic files to initialize sprint-status.yaml, which tracks all stories through development. Run once before starting.

+
+
+
+ Agent: SM + create-story + +
+

Uses the epic and sprint-status to prepare a story-[slug].md file with full context and acceptance criteria, ready for development.

+
+
+
+ Agent: DEV + dev-story + +
+

Uses the story file and architecture to implement production code and tests following established patterns.

+
+
+
+ Agent: DEV + code-review + +
+

Reviews your implemented code for quality, architecture alignment, tests, and security, producing a review report.

+
+
+
+ Agent: SM + epic-retrospective + +
+

Reviews the completed epic to capture team learnings and create retrospective notes for improving the next epic.

+
+
+
+
+
+
+ + + + diff --git a/website/src/pages/workflow-guide.astro b/website/src/pages/workflow-guide.astro new file mode 100644 index 00000000..f9f929df --- /dev/null +++ b/website/src/pages/workflow-guide.astro @@ -0,0 +1,17 @@ +--- +import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro'; +import WorkflowGuide from '../components/WorkflowGuide.astro'; +--- + + +

+ This interactive guide helps you understand which workflows to run, which agents to use, and what outputs to expect at each phase. Select your project's track to see the relevant path. +

+ +