mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
2e16650067
* feat(docs): add Diataxis folder structure and update sidebar styling - Create tutorials, how-to, explanation, reference directories with subdirectories - Add index.md files for each main Diataxis section - Update homepage with Diataxis card navigation layout - Implement clean React Native-inspired sidebar styling - Convert sidebar to autogenerated for both Diataxis and legacy sections - Update docusaurus config with dark mode default and navbar changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): migrate Phase 1 files to Diataxis structure Move 21 files to new locations: - Tutorials: quick-start guides, agent creation guide - How-To: installation, customization, workflows - Explanation: core concepts, features, game-dev, builder - Reference: merged glossary from BMM and BMGD Also: - Copy images to new locations - Update internal links via migration script (73 links updated) - Build verified successfully 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(docs): add category labels for sidebar folders Add _category_.json files to control display labels and position for autogenerated sidebar categories. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * style(docs): improve welcome page and visual styling - Rewrite index.md with React Native-inspired welcoming layout - Add Diataxis section cards with descriptions - Remove sidebar separator, add spacing instead - Increase navbar padding with responsive breakpoints - Add rounded admonitions without left border bar - Use system font stack for better readability - Add lighter chevron styling in sidebar - Constrain max-width to 1600px for wide viewports 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use baseUrl in meta tag paths for correct deployment URLs * feat(docs): complete Phase 2 - split files and fix broken links Phase 2 of Diataxis migration: - Split 16 large legacy files into 42+ focused documents - Created FAQ section with 7 topic-specific files - Created brownfield how-to guides (3 files) - Created workflow how-to guides (15+ files) - Created architecture explanation files (3 files) - Created TEA/testing explanation files - Moved remaining legacy module files to proper Diataxis locations Link fixes: - Fixed ~50 broken internal links across documentation - Updated relative paths for new file locations - Created missing index files for installation, advanced tutorials - Simplified TOC anchors to fix Docusaurus warnings Cleanup: - Removed legacy sidebar entries for deleted folders - Deleted duplicate and empty placeholder files - Moved workflow diagram assets to tutorials/images 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(build): use file glob instead of sidebar parsing for llms-full.txt Replace brittle sidebar.js regex parsing with recursive file glob. The old approach captured non-file strings like 'autogenerated' and category labels, resulting in only 5 files being processed. Now correctly processes all 86+ markdown files (~95k tokens). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(seo): use absolute URLs in AI meta tags for agent discoverability AI web-browsing agents couldn't follow relative paths in meta tags due to URL security restrictions. Changed llms-full.txt and llms.txt meta tag URLs from relative (baseUrl) to absolute (urlParts.origin + baseUrl). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): recategorize misplaced files per Diataxis analysis Phase 2.5 categorization fixes based on post-migration analysis: Moved to correct Diataxis categories: - tutorials/installation.md → deleted (duplicate of how-to/install-bmad.md) - tutorials/brownfield-onboarding.md → how-to/brownfield/index.md - reference/faq/* (8 files) → explanation/faq/ - reference/agents/barry-quick-flow.md → explanation/agents/ - reference/agents/bmgd-agents.md → explanation/game-dev/agents.md Created: - explanation/agents/index.md Fixed all broken internal links (14 total) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add Getting Started tutorial and simplify build script - Add comprehensive Getting Started tutorial with installation as Step 1 - Simplify build-docs.js to read directly from docs/ (no consolidation) - Remove backup/restore dance that could corrupt docs folder on build failure - Remove ~150 lines of unused consolidation code 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(css): use fixed width layout to prevent content shifting Apply React Native docs approach: set both width and max-width at largest breakpoint (1400px) so content area maintains consistent size regardless of content length. Switches to fluid 100% below 1416px breakpoint. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): restructure tutorials with renamed entry point - Rename index.md to bmad-tutorial.md for clearer navigation - Remove redundant tutorials/index.md - Update sidebar and config references 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add tutorial style guide and AI agent announcement bar - Add docs/_contributing/ with tutorial style guide - Reformat quick-start-bmm.md and bmad-tutorial.md per style guide - Remove horizontal separators, add strategic admonitions - Add persistent announcement bar for AI agents directing to llms-full.txt - Fix footer broken link to tutorials 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add markdown demo page and UI refinements - Add comprehensive markdown-demo.md for style testing - Remove doc category links from navbar (use sidebar instead) - Remove card buttons from welcome page - Add dark mode styling for announcement bar - Clean up index.md card layout 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): apply unified tutorial style and update references - Reformat create-custom-agent.md to follow tutorial style guide - Update tutorial-style.md with complete unified structure - Update all internal references to renamed tutorial files - Remove obsolete advanced/index.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): migrate from Docusaurus to Astro+Starlight Replace Docusaurus with Astro and the Starlight documentation theme for improved performance, better customization, and modern tooling. Build pipeline changes: - New build-docs.js orchestrates link checking, artifact generation, and Astro build in sequence - Add check-doc-links.js for validating internal links and anchors - Generate llms.txt and llms-full.txt for LLM-friendly documentation - Create downloadable source bundles (bmad-sources.zip, bmad-prompts.zip) - Suppress MODULE_TYPELESS_PACKAGE_JSON warning in Astro build - Output directly to build/site for cleaner deployment Website architecture: - Add rehype-markdown-links.js plugin to transform .md links to routes - Add site-url.js helper for GitHub Pages URL resolution with strict validation (throws on invalid GITHUB_REPOSITORY format) - Custom Astro components: Banner, Header, MobileMenuFooter - Symlink docs/ into website/src/content/docs for Starlight Documentation cleanup: - Remove Docusaurus _category_.json files (Starlight uses frontmatter) - Convert all docs to use YAML frontmatter with title field - Move downloads.md from website/src/pages to docs/ - Consolidate style guide and workflow diagram docs - Add 404.md and tutorials/index.md --------- Co-authored-by: forcetrainer <bryan@inagaki.us> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
BMad Method & BMad Core
🎉 NEW: BMAD V6 Installer - Create & Share Custom Content!
The completely revamped BMAD V6 installer now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal!
✨ What's New:
- 📦 Streamlined Custom Module Installation - Package your custom content as installable modules
- 🤖 Agent & Workflow Sharing - Distribute standalone agents and workflows
- 🔄 Unitary Module Support - Install individual components without full modules
- ⚙️ Dependency Management - Automatic handling of module dependencies
- 🛡️ Update-Safe Customization - Your custom content persists through updates
📚 Learn More:
- Custom Content Overview - Discover all supported content types
- Installation Guide - Learn to create and install custom content
- 2 Very simple Custom Modules of questionable quality - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
Build More, Architect Dreams (BMAD) with 21 specialized AI agents across 4 official modules, and 50+ guided workflows that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits!
🚀 v6 is a MASSIVE upgrade from v4! Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. See what's new →
📌 v6 Alpha Status: Near-beta quality with vastly improved stability. Documentation is being finalized. New videos coming soon to BMadCode YouTube.
🎯 Why BMad Method?
Unlike generic AI coding assistants, BMad Method provides structured, battle-tested workflows powered by specialized agents who understand agile development. Each agent has deep domain expertise—from product management to architecture to testing—working together seamlessly.
✨ Key Benefits:
- Scale-Adaptive Intelligence - Automatically adjusts planning depth from bug fixes to enterprise systems
- Complete Development Lifecycle - Analysis → Planning → Architecture → Implementation
- Specialized Expertise - 19 agents with specific roles (PM, Architect, Developer, UX Designer, etc.)
- Proven Methodologies - Built on agile best practices with AI amplification
- IDE Integration - Works with Claude Code, Cursor, Windsurf, VS Code
🏗️ The Power of BMad Core
BMad Method is actually a sophisticated module built on top of BMad Core (Collaboration Optimized Reflection Engine). This revolutionary architecture means:
- BMad Core provides the universal framework for human-AI collaboration
- BMad Method leverages Core to deliver agile development workflows
- BMad Builder lets YOU create custom modules as powerful as BMad Method itself
With BMad Builder, you can architect both simple agents and vastly complex domain-specific modules (legal, medical, finance, education, creative) that will soon be sharable in an official community marketplace. Imagine building and sharing your own specialized AI team!
📊 See It In Action
Complete BMad Method workflow showing all phases, agents, and decision points
🚀 Get Started in 3 Steps
1. Install BMad Method
# Install v6 RECOMMENDED
npx bmad-method@alpha install
# Install v4 Legacy (not recommended if starting fresh)
npx bmad-method install
# OR
npx bmad-method@latest install
2. Initialize Your Project
Load any agent in your IDE and run:
*workflow-init
This analyzes your project and recommends the right workflow track.
3. Choose Your Track
BMad Method adapts to your needs with three intelligent tracks:
| Track | Use For | Planning | Time to Start |
|---|---|---|---|
| ⚡ Quick Flow | Bug fixes, small features | Tech spec only | < 5 minutes |
| 📋 BMad Method | Products, platforms | PRD + Architecture + UX | < 15 minutes |
| 🏢 Enterprise | Compliance, scale | Full governance suite | < 30 minutes |
Not sure? Run
*workflow-initand let BMad analyze your project goal.
🔄 How It Works: 4-Phase Methodology
BMad Method guides you through a proven development lifecycle:
- 📊 Analysis (Optional) - Brainstorm, research, and explore solutions
- 📝 Planning - Create PRDs, tech specs, or game design documents
- 🏗️ Solutioning - Design architecture, UX, and technical approach
- ⚡ Implementation - Story-driven development with continuous validation
Each phase has specialized workflows and agents working together to deliver exceptional results.
🤖 Meet Your Team
12 Specialized Agents working in concert:
| Development | Architecture | Product | Leadership |
|---|---|---|---|
| Developer | Architect | PM | Scrum Master |
| UX Designer | Test Architect | Analyst | BMad Master |
| Tech Writer |
Test Architect integrates with @seontechnologies/playwright-utils for production-ready web app fixture-based utilities.
Each agent brings deep expertise and can be customized to match your team's style.
📦 What's Included
Official Modules
-
BMad Method (BMM) - Complete agile development framework
- 12 specialized agents
- 34 workflows across 4 phases
- Stand Along Quick Spec Flow for a streamlined simple implementation process
- → Documentation Hub
-
BMad Builder (BMB) - Create custom agents and workflows
- Build anything from simple agents to complex modules
- Create domain-specific solutions (legal, medical, finance, education)
- → Builder Guide
-
Creative Intelligence Suite (CIS) - Innovation & problem-solving
- Brainstorming, design thinking, storytelling
- 5 creative facilitation workflows
- → Creative Workflows
Key Features
- 🎨 Customizable Agents - Modify personalities, expertise, and communication styles
- 🌐 Multi-Language Support - Separate settings for communication and code output
- 📄 Document Sharding - 90% token savings for large projects
- 🔄 Update-Safe - Your customizations persist through updates
- 🚀 Web Bundles - Use in ChatGPT, Claude Projects, or Gemini Gems
📚 Documentation
Quick Links
- Quick Start Guide - 15-minute introduction
- Complete BMM Documentation - All guides and references
- Agent Customization - Personalize your agents
- All Documentation - Complete documentation index
For v4 Users
💬 Community & Support
- Discord Community - Get help, share projects
- GitHub Issues - Report bugs, request features
- YouTube Channel - Video tutorials and demos
- Web Bundles - Pre-built agent bundles (Currently not functioning, reworking soon)
- Code of Conduct - Community guidelines
🛠️ Development
If you would like to contribute, first check the CONTRIBUTING.md for full development guidelines.
What's New in v6
v6 represents a complete architectural revolution from v4:
🚀 Major Upgrades
- BMad Core Framework - Modular architecture enabling custom domain solutions
- Scale-Adaptive Intelligence - Automatic adjustment from bug fixes to enterprise
- Visual Workflows - Beautiful SVG diagrams showing complete methodology
- BMad Builder Module - Create and share your own AI agent teams
- 50+ Workflows - Up from 20 in v4, covering every development scenario
- 19 Specialized Agents - Enhanced with customizable personalities and expertise
- Update-Safe Customization - Your configs persist through all updates
- Web Bundles - Use agents in ChatGPT, Claude, and Gemini
- Multi-Language Support - Separate settings for communication and code
- Document Sharding - 90% token savings for large projects
🔄 For v4 Users
- Comprehensive Upgrade Guide - Step-by-step migration
- v4 Documentation Archive - Legacy reference
- Backwards compatibility where possible
- Smooth migration path with installer detection
📄 License
MIT License - See LICENSE for details.
Trademarks: BMad™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
Supported by: 
Built with ❤️ for the human-AI collaboration community