From 0a3cc1d12c666727f0d4b9bc23748c3972c49d60 Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Sun, 11 Jan 2026 13:16:49 +0800 Subject: [PATCH] release: bump to v6.0.0-alpha.23 --- CHANGELOG.md | 153 +++++++++++++++++++++ package-lock.json | 17 +-- package.json | 2 +- tools/cli/installers/install-messages.yaml | 66 ++++----- 4 files changed, 189 insertions(+), 49 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e23cf8b0..7f266887 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,158 @@ # Changelog +## [6.0.0-alpha.23] + +**Release: January 11, 2026** + +### ๐ŸŒŸ Key Highlights + +1. **Astro/Starlight Documentation Platform**: Complete migration from Docusaurus to modern Astro+Starlight for superior performance and customization +2. **Diataxis Framework Implementation**: Professional documentation restructuring with tutorials, how-to guides, explanations, and references +3. **Workflow Creator & Validator**: Powerful new tools for workflow creation with subprocess support and PRD validation +4. **TEA Documentation Expansion**: Comprehensive testing documentation with cheat sheets, MCP enhancements, and API testing patterns +5. **Brainstorming Revolution**: Research-backed procedural rigor with 100+ idea goal and anti-bias protocols +6. **Cursor IDE Modernization**: Refactored from rules-based to command-based architecture for better IDE integration + +### ๐Ÿ“š Documentation Platform Revolution + +**Astro/Starlight Migration:** + +- **From Docusaurus to Astro**: Complete platform migration for improved performance, better customization, and modern tooling +- **Starlight Theme**: Professional documentation theme with dark mode default and responsive design +- **Build Pipeline Overhaul**: New build-docs.js orchestrates link checking, artifact generation, and Astro build +- **LLM-Friendly Documentation**: Generated llms.txt and llms-full.txt for AI agent discoverability +- **Downloadable Source Bundles**: bmad-sources.zip and bmad-prompts.zip for offline use + +**Diataxis Framework Implementation:** + +- **Four Content Types**: Professional separation into tutorials, how-to guides, explanations, and references +- **21 Files Migrated**: Phase 1 migration of core documentation to Diataxis structure +- **42+ Focused Documents**: Phase 2 split of large legacy files into manageable pieces +- **FAQ Restructuring**: 7 topic-specific FAQ files with standardized format +- **Tutorial Style Guide**: Comprehensive documentation standards for consistent content creation + +**Link Management & Quality:** + +- **Site-Relative Links**: Converted 217 links to repo-relative format (/docs/path/file.md) +- **Link Validation Tools**: New validate-doc-links.js and fix-doc-links.js for maintaining link integrity +- **Broken Link Fixes**: Resolved ~50 broken internal links across documentation +- **BMad Acronym Standardization**: Consistent use of "BMad" (Breakthrough Method of Agile AI Driven Development) +- **SEO Optimization**: Absolute URLs in AI meta tags for better web crawler discoverability + +### ๐Ÿ”ง Workflow Creator & Validator (Major Feature) + +**Workflow Creation Tool:** + +- **Subprocess Support**: Advanced workflows can now spawn subprocesses for complex operations +- **PRD Validation Step**: New validation step ensures PRD quality before workflow execution +- **Trimodal Workflow Creation**: Three-mode workflow generation system +- **Quadrivariate Module Workflow**: Four-variable workflow architecture for enhanced flexibility +- **Path Violation Checks**: Validator ensures workflows don't violate path constraints +- **Max Parallel Mode POC**: Proof-of-concept for parallel workflow validation + +**Workflow Quality Improvements:** + +- **PRD Trimodal Compliance**: PRD workflow now follows trimodal standards +- **Standardized Step Formatting**: Consistent markdown formatting across workflow and PRD steps +- **Better Suggested Next Steps**: Improved workflow completion guidance +- **Variable Naming Standardization**: {project_root} โ†’ {project-root} across all workflows + +### ๐Ÿงช TEA Documentation Expansion + +**Comprehensive Testing Guides:** + +- **Cheat Sheets**: Quick reference guides for common testing scenarios +- **MCP Enhancements**: Model Context Protocol improvements for testing workflows +- **API Testing Patterns**: Best practices for API testing documentation +- **Design Philosophy Callout**: Clear explanation of TEA's design principles +- **Context Engineering Glossary**: New glossary entry defining context engineering concepts +- **Fragment Count Updates**: Accurate documentation of TEA workflow components +- **Playwright Utils Examples**: Updated code examples for playwright-utils integration + +### ๐Ÿ’ก Brainstorming Workflow Overhaul + +**Research-Backed Procedural Rigor:** + +- **100+ Idea Goal**: Emphasis on quantity-first approach to unlock better quality ideas +- **Anti-Bias Protocol**: Domain pivot every 10 ideas to reduce cognitive biases +- **Chain-of-Thought Requirements**: Reasoning before idea generation +- **Simulated Temperature**: Prompts for higher divergence in ideation +- **Standardized Idea Format**: Quality control template for consistent output +- **Energy Checkpoints**: Multiple continuation options to maintain creative flow + +**Exploration Menu Improvements:** + +- **Letter-Based Navigation**: [K/T/A/B/C] options instead of numbers for clarity +- **Keep/Try/Advanced/Break/Continue**: Clear action options for idea refinement +- **Universal Facilitation Rules**: Consistent guidelines across all brainstorming steps +- **Quality Growth Enforcement**: Balance between quantity and quality metrics + +### ๐Ÿ–ฅ๏ธ Cursor IDE Modernization + +**Command-Based Architecture:** + +- **From Rules to Commands**: Complete refactor from rules-based to command-based system +- **Command Generation**: Automatic generation of task and tool commands +- **Commands Directory**: New `.cursor/commands/bmad/` structure for generated commands +- **Cleanup Integration**: Automatic cleanup of old BMAD commands alongside rules +- **Enhanced Logging**: Better feedback on agents, tasks, tools, and workflow commands generated + +### ๐Ÿค– Agent System Improvements + +**Agent Builder & Validation:** + +- **hasSidecar Field**: All agents now indicate sidecar support (true/false) +- **Validation Enforcement**: hasSidecar now required in agent validation +- **Better Brownfield Documentation**: Improved brownfield project documentation +- **Agent Builder Updates**: Agent builder now uses hasSidecar field +- **Agent Editor Integration**: Editor workflow respects hasSidecar configuration + +### ๐Ÿ› Bug Fixes & Quality Improvements + +**Critical Fixes:** + +- **Windows Line Endings**: Resolved CRLF issues causing cross-platform problems +- **Code-Review File Filtering**: Fixed code-review picking up non-application files +- **ERR_REQUIRE_ESM Resolution**: Dynamic import for inquirer v9+ compatibility +- **Project-Context Conflicts**: Allow full project-context usage with conflict precedence +- **Workflow Paths**: Fixed paths for workflow and sprint status files +- **Missing Scripts**: Fixed missing scripts from installation + +**Workflow & Variable Fixes:** + +- **Variable Naming**: Standardized from {project_root} to {project-root} across CIS, BMGD, and BMM modules +- **Workflow References**: Fixed broken .yaml โ†’ .md workflow references +- **Advanced Elicitation Variables**: Fixed undefined variables in brainstorming +- **Dependency Format**: Corrected dependency format and added missing frontmatter + +**Code Quality:** + +- **Dependency Updates**: Bumped qs from 6.14.0 to 6.14.1 +- **CodeRabbit Integration**: Enabled auto-review on new PRs +- **TEA Fragment Counts**: Updated fragment counts for accuracy +- **Documentation Links**: Fixed Discord channel references (#general-dev โ†’ #bmad-development) + +### ๐Ÿš€ Installation & CLI Improvements + +**Installation Enhancements:** + +- **Workflow Exclusion**: Ability to exclude workflows from being added as commands +- **Example Workflow Protection**: Example workflow in workflow builder now excluded from tools +- **CNAME Configuration**: Added CNAME file for custom domain support +- **Script Fixes**: All scripts now properly included in installation + +### ๐Ÿ“Š Statistics + +- **27 commits** since alpha.22 +- **217 documentation links** converted to site-relative format +- **42+ focused documents** created from large legacy files +- **7 topic-specific FAQ files** with standardized formatting +- **Complete documentation platform** migrated from Docusaurus to Astro/Starlight +- **Major workflow tools** added: Creator, Validator with subprocess support +- **Brainstorming workflow** overhauled with research-backed rigor + +--- + ## [6.0.0-alpha.22] **Release: December 31, 2025** diff --git a/package-lock.json b/package-lock.json index d6ea4f26..b5a2a4ba 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "bmad-method", - "version": "6.0.0-alpha.22", + "version": "6.0.0-alpha.23", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "bmad-method", - "version": "6.0.0-alpha.22", + "version": "6.0.0-alpha.23", "license": "MIT", "dependencies": { "@kayvan/markdown-tree-parser": "^1.6.1", @@ -244,7 +244,6 @@ "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@babel/code-frame": "^7.27.1", "@babel/generator": "^7.28.5", @@ -3643,7 +3642,6 @@ "integrity": "sha512-W609buLVRVmeW693xKfzHeIV6nJGGz98uCPfeXI1ELMLXVeKYZ9m15fAMSaUPBHYLGFsVRcMmSCksQOrZV9BYA==", "devOptional": true, "license": "MIT", - "peer": true, "dependencies": { "undici-types": "~7.16.0" } @@ -3983,7 +3981,6 @@ "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "dev": true, "license": "MIT", - "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -4290,7 +4287,6 @@ "integrity": "sha512-6mF/YrvwwRxLTu+aMEa5pwzKUNl5ZetWbTyZCs9Um0F12HUmxUiF5UHiZPy4rifzU3gtpM3xP2DfdmkNX9eZRg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@astrojs/compiler": "^2.13.0", "@astrojs/internal-helpers": "0.7.5", @@ -5358,7 +5354,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.9.0", "caniuse-lite": "^1.0.30001759", @@ -6689,7 +6684,6 @@ "integrity": "sha512-LEyamqS7W5HB3ujJyvi0HQK/dtVINZvd5mAAp9eT5S/ujByGjiZLCzPcHVzuXbpJDJF/cxwHlfceVUDZ2lnSTw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", @@ -10304,7 +10298,6 @@ "integrity": "sha512-p3JTemJJbkiMjXEMiFwgm0v6ym5g8K+b2oDny+6xdl300tUKySxvilJQLSea48C6OaYNmO30kH9KxpiAg5bWJw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "globby": "15.0.0", "js-yaml": "4.1.1", @@ -12378,7 +12371,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -12444,7 +12436,6 @@ "integrity": "sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA==", "dev": true, "license": "MIT", - "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -13273,7 +13264,6 @@ "integrity": "sha512-3nk8Y3a9Ea8szgKhinMlGMhGMw89mqule3KWczxhIzqudyHdCIOHw8WJlj/r329fACjKLEh13ZSk7oE22kyeIw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@types/estree": "1.0.8" }, @@ -14837,7 +14827,6 @@ "integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.4", @@ -15111,7 +15100,6 @@ "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", "license": "ISC", - "peer": true, "bin": { "yaml": "bin.mjs" }, @@ -15303,7 +15291,6 @@ "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", "dev": true, "license": "MIT", - "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } diff --git a/package.json b/package.json index a46171e3..1f090907 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "$schema": "https://json.schemastore.org/package.json", "name": "bmad-method", - "version": "6.0.0-alpha.22", + "version": "6.0.0-alpha.23", "description": "Breakthrough Method of Agile AI-driven Development", "keywords": [ "agile", diff --git a/tools/cli/installers/install-messages.yaml b/tools/cli/installers/install-messages.yaml index e44a3228..860b8352 100644 --- a/tools/cli/installers/install-messages.yaml +++ b/tools/cli/installers/install-messages.yaml @@ -6,28 +6,24 @@ startMessage: | โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ” - If you are looking for Version 4 of BMad Method, please note that you can - still install it by using the command `npx bmad-method@latest install`, until v6 reaches beta. + โญ IMPORTANT: Version Alpha.23 Changes - IMPORTANT Changes with Version Alpha.22 - PLEASE READ THIS if upgrading from earlier Alpha Versions: + If your current version is older than Alpha.21, you'll need a fresh install: + - Remove .bmad folder and reinstall + - Only needed during final push to beta (ETA January 18th) - 1. The BMad Core default output folder has changed from `docs` to `_bmad-output`. `docs` - is meant for long-term artifacts, which you can always decide to move content to. + ๐Ÿ“š New Docs Site: http://docs.bmad-method.org/ + - Tons of guides and articles coming soon! + - Everything is free. No paywalls. No gated content. + - Knowledge should be shared, not sold. - 2. If utilizing the BMad Method Module (BMM) please be aware of the following important recent changes: + ๐Ÿ“บ YouTube Master Class & Podcast launching February 1st! - - Phases 1-3 (Analysis, Planning, Solutioning) will now default output to _bmad-output/planning-artifacts - - Phase 4 (Implementation) will now default output to _bmad-output/implementation-artifacts - - Long term project knowledge (research, docs, references, document-project output) will now default to docs/ + ๐Ÿ’ก Love BMad? Please star us on GitHub & subscribe on YouTube! + - GitHub: https://github.com/bmad-code-org/BMAD-METHOD/ + - YouTube: https://www.youtube.com/@BMadCode - IT IS STRONGLY SUGGESTED to align with these folder conventions instead of dumping all to docs/ - if you are upgrading from a prior - version where all output was going to docs or docs/sprint-artifacts, it is suggested to reset configs to these new values. - - If you have anything in progress, you can move what was in sprint-artifacts to _bmad-output/implementation-artifacts, - and if you had brainstorming content, a PRD, UX or Architecture, you can move the content to _bmad-output/planning-artifacts. - - Read the latest updates before continuing: - https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md + Latest updates: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ” @@ -35,24 +31,28 @@ startMessage: | endMessage: | โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ• - โœจ BMAD IS READY TO USE! + โœจ BMAD IS READY! Beta is just days away! Thank you for your support! - ONE FINAL NOTE WITH VERSION Alpha.22: Phase 4 (Implementation) is still in the process of - being migrated to the improved workflow progressive disclosure system. - Along with this, the full conversion to the new path locations for content being searched - may possibly be incomplete. If you run a workflow that relies on finding input documents - automatically, and you notice they are not being found / looking in the wrong location, either: - 1. Manually specify the correct input location when prompted - 2. Open an issue on GitHub so we can address the problem quickly if you think its a bug. - 3. Ensure your content is in the new locations for best results: - - Planning Artifacts (Phases 1-3): _bmad-output/planning-artifacts - - Implementation Artifacts (Phase 4): _bmad-output/implementation-artifacts - - Long Term Project Knowledge (docs, research, references): docs/ + ๐ŸŒŸ BMad is 100% free and open source. + - No gated Discord. No paywalls. + - We believe in empowering everyone, not just those who can pay. - Thank you for helping test the early release version of the new BMad Core and BMad Method! - Stable Beta coming soon - please read the full README.md and linked documentation to get started. + ๐Ÿ™ SUPPORT BMAD DEVELOPMENT: + - Donate: https://buymeacoffee.com/bmad + - Corporate Sponsorship available - DM on Discord - And again, here is the Change Log with all the details of recent updates: - https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md + ๐ŸŽค SPEAKING & MEDIA: + - Available for conferences, podcasts, and media appearances + - Topics: AI-Native Transformation, Spec and Context Engineering, BMad Method + - For speaking inquiries or interviews, reach out to BMad on Discord! + + ๐Ÿ“š RESOURCES: + - Docs: http://docs.bmad-method.org/ (bookmark it!) + - Changelog: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md + + โญโญโญ HELP US GROW: + - Star us on GitHub: https://github.com/bmad-code-org/BMAD-METHOD/ + - Subscribe on YouTube: https://www.youtube.com/@BMadCode + - Every star & sub helps us reach more developers! โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•