bmad-method 4.9.0 → 4.9.2

package/docs/core-architecture.md

@@ -16,7 +16,7 @@ The system facilitates a full development lifecycle:
 
 The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
 
-````mermaid
+```mermaid
 graph TD
     subgraph BMAD Method Project
         subgraph Core Framework
@@ -59,7 +59,7 @@ graph TD
     style A fill:#1a73e8,color:#fff
     style I fill:#f9ab00,color:#fff
     style J fill:#34a853,color:#fff
-```text
+```
 
 ## 3. Core Components
 
@@ -110,6 +110,7 @@ The system maintains a clean separation of concerns: template markup is processe
 BMAD includes a personalization layer through the `technical-preferences.md` file in `.bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
 
 **Purpose and Benefits:**
+
 - **Consistency**: Ensures all agents reference the same technical preferences
 - **Efficiency**: Eliminates the need to repeatedly specify preferred technologies
 - **Personalization**: Agents provide recommendations aligned with user preferences
@@ -119,6 +120,7 @@ BMAD includes a personalization layer through the `technical-preferences.md` fil
 The file typically includes preferred technology stacks, design patterns, external services, coding standards, and anti-patterns to avoid. Agents automatically reference this file during planning and development to provide contextually appropriate suggestions.
 
 **Integration Points:**
+
 - Templates can reference technical preferences during document generation
 - Agents suggest preferred technologies when appropriate for project requirements
 - When preferences don't fit project needs, agents explain alternatives
@@ -173,7 +175,7 @@ graph TD
     style G fill:#f9ab00,color:#fff
     style L fill:#1a73e8,color:#fff
     style N fill:#34a853,color:#fff
-````
+```
 
 **Key Planning Phases:**
 

package/docs/how-to-contribute-with-pull-requests.md

@@ -20,11 +20,11 @@ A pull request (PR) is how you propose changes to a project on GitHub. Think of
 
 ### 2. Clone Your Fork
 
-````bash
+```bash
 # Replace YOUR-USERNAME with your actual GitHub username
 git clone https://github.com/YOUR-USERNAME/bmad-method.git
 cd bmad-method
-```text
+```
 
 ### 3. Create a New Branch
 
@@ -35,7 +35,7 @@ cd bmad-method
 git checkout -b fix/typo-in-readme
 # or
 git checkout -b feature/add-new-agent
-````
+```
 
 **Branch naming tips:**
 
@@ -51,13 +51,13 @@ git checkout -b feature/add-new-agent
 
 ### 5. Commit Your Changes
 
-````bash
+```bash
 # Add your changes
 git add .
 
 # Commit with a clear message
 git commit -m "Fix typo in README.md"
-```text
+```
 
 **Good commit messages:**
 
@@ -76,7 +76,7 @@ git commit -m "Fix typo in README.md"
 ```bash
 # Push your branch to your fork
 git push origin fix/typo-in-readme
-````
+```
 
 ### 7. Create the Pull Request
 

package/docs/user-guide.md

@@ -56,10 +56,10 @@ Best for: ChatGPT, Claude, Gemini users
 
 Best for: Cursor, Claude Code, Windsurf, VS Code users
 
-````bash
+```bash
 # Interactive installation (recommended)
 npx bmad-method install
-```text
+```
 
 ### First Steps
 
@@ -106,7 +106,7 @@ dependencies:
     - shard-doc.md
   data:
     - bmad-kb.md
-````
+```
 
 **Key Points:**
 
@@ -118,7 +118,7 @@ dependencies:
 
 **In IDE:**
 
-````bash
+```bash
 # Cursor or Windsurf (manual rules - loaded with @)
 @pm Create a PRD for a task management app
 @architect Design the system architecture
@@ -127,7 +127,7 @@ dependencies:
 # Claude Code (files in commands folder - loaded with /)
 /pm Create user stories
 /dev Fix the login bug
-```text
+```
 
 **In Web UI:**
 
@@ -135,7 +135,7 @@ dependencies:
 /pm create-doc prd
 /architect review system design
 /dev implement story 1.2
-````
+```
 
 ## Templates and Document Creation
 
@@ -224,10 +224,9 @@ When working directly in IDEs:
 
 Templates can include `advanced-elicitation.md` for enhanced interaction:
 
-`````markdown
+```markdown
 [[LLM: Use advanced-elicitation actions 0-3 to refine requirements]]
-
-````text
+```
 
 This provides 10 structured brainstorming actions:
 
@@ -268,10 +267,7 @@ graph TD
     style G fill:#f9ab00,color:#fff
     style L fill:#1a73e8,color:#fff
     style N fill:#34a853,color:#fff
-````
-`````
-
-`````
+```
 
 #### Web UI to IDE Transition
 
@@ -286,7 +282,7 @@ graph TD
 
 Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
 
-````mermaid
+```mermaid
 graph TD
     A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
     B --> C["PO: Shard Arch"]
@@ -302,7 +298,7 @@ graph TD
     J --> E
 
     style J fill:#34a853,color:#fff
-```text
+```
 
 ### Workflow Phases
 
@@ -391,7 +387,7 @@ agents:
   - qa
 workflows:
   - greenfield-fullstack
-`````
+```
 
 ## IDE Integration
 
@@ -543,7 +539,7 @@ BMAD's dependency system ensures agents only load necessary resources:
 
 Create custom templates following `template-format.md`:
 
-`````markdown
+```markdown
 ---
 title: Custom Template
 description: Your custom document type
@@ -564,8 +560,7 @@ dependencies:
 ## Section 2
 
 {{section_2_content}}
-
-````text
+```
 
 ### Workflow Customization
 
@@ -594,10 +589,7 @@ phases:
     deliverables:
       - implementation
       - tests
-````
-`````
-
-`````
+```
 
 ### Creating Custom Templates
 
@@ -605,7 +597,7 @@ Templates are self-contained documents that embed both output structure and proc
 
 #### Template Structure
 
-````markdown
+```markdown
 # {{Project Name}} Document Title
 
 [[LLM: Opening instruction for AI processing]]
@@ -627,30 +619,32 @@ Templates are self-contained documents that embed both output structure and proc
 
 [[LLM: Only include if condition is met]]
 ^^/CONDITION^^
-
-````text
+```
 
 #### Key Template Patterns
 
 **Variable Substitution:**
+
 - `{{Project Name}}` - Dynamic project name
 - `{{document_title}}` - Document-specific title
 - `{{section_content}}` - Placeholder for generated content
 
 **AI Processing Instructions:**
+
 - `[[LLM: Instructions for AI behavior]]` - AI-only processing directives
 - `@{example: Sample content}` - Guidance examples (not output)
 - `tasks#advanced-elicitation` - Reference to embedded tasks
 
 **Conditional Content:**
+
 ```markdown
 ^^CONDITION: has_ui^^
+
 ## User Interface Section
+
 [[LLM: Only include for UI projects]]
 ^^/CONDITION^^
-`````
-
-`````
+```
 
 #### Document Sharding
 
@@ -658,7 +652,7 @@ Level 2 headings (`##`) in templates can be automatically sharded into separate
 
 **Original PRD:**
 
-````markdown
+```markdown
 ## Goals and Background Context
 
 ## Requirements
@@ -666,10 +660,10 @@ Level 2 headings (`##`) in templates can be automatically sharded into separate
 ## User Interface Design Goals
 
 ## Success Metrics
-
-````text
+```
 
 **After Sharding:**
+
 - `docs/prd/goals-and-background-context.md`
 - `docs/prd/requirements.md`
 - `docs/prd/user-interface-design-goals.md`
@@ -694,43 +688,40 @@ Tasks are reusable automation instructions that agents can execute. They follow
 ## Instructions
 
 ### 1. Step One
+
 - Detailed instructions for the agent
 - Specific behaviors and outputs expected
 
 ### 2. Step Two
+
 - Additional processing steps
 - Integration with other resources
 
 ## Examples
 
 @{example: Concrete usage examples}
-`````
-
-`````
+```
 
 #### Task Patterns
 
 **Resource Integration:**
 
-````markdown
+```markdown
 [[LLM: Check if docs/coding-standards.md exists and reference it]]
 [[LLM: Load docs/openapi-spec.yaml for API context]]
-
-````text
+```
 
 **Advanced Elicitation:**
+
 ```markdown
 [[LLM: Apply tasks#advanced-elicitation protocol after completion]]
-`````
-
-`````
+```
 
 **Conditional Logic:**
 
-````markdown
+```markdown
 [[LLM: If project has UI components, also check frontend standards]]
-
-````text
+```
 
 ### Creating Custom Agents
 
@@ -764,21 +755,19 @@ dependencies:
     - custom-task.md
   data:
     - domain-knowledge.md
-`````
-
-`````
+```
 
 #### Agent Startup Instructions
 
 Agents can load project-specific documents and provide custom context:
 
-````yaml
+```yaml
 startup:
   - Load docs/coding-standards.md if available
   - Review docs/project-structure.md for context
   - Check for docs/third-party-apis/ folder
   - Announce specialized capabilities
-```text
+```
 
 #### Loading Project Documents
 
@@ -794,11 +783,12 @@ Agents can reference and load documents from the `docs/` folder:
 
 ```markdown
 [[LLM: Before beginning, check for and load relevant context:
+
 - docs/coding-standards.md for development standards
 - docs/brand-guidelines.md for design consistency
 - docs/third-party-apis/ for integration requirements
 - Any project-specific documentation in docs/ folder]]
-`````
+```
 
 ### Technical Preferences System
 
@@ -812,7 +802,7 @@ This file allows you to define your preferred technologies, patterns, and standa
 
 **Technology Stack Preferences:**
 
-`````markdown
+```markdown
 ## Preferred Technologies
 
 ### Frontend
@@ -831,29 +821,28 @@ This file allows you to define your preferred technologies, patterns, and standa
 
 - Vercel for frontend
 - Railway for backend services
-
-````text
+```
 
 **Design Patterns & Standards:**
+
 ```markdown
 ## Code Standards
+
 - Use functional programming patterns where possible
 - Prefer composition over inheritance
 - Always include comprehensive error handling
 - Write tests for all business logic
 
 ## Architecture Preferences
+
 - Microservices for complex applications
 - RESTful APIs with OpenAPI documentation
 - Event-driven architecture for real-time features
-````
-`````
-
-`````
+```
 
 **External Services & APIs:**
 
-````markdown
+```markdown
 ## Preferred External Services
 
 - Auth0 for authentication
@@ -865,8 +854,7 @@ This file allows you to define your preferred technologies, patterns, and standa
 
 - Legacy SOAP services
 - Services without proper documentation
-
-````text
+```
 
 #### How Agents Use This File
 
@@ -880,21 +868,19 @@ This file allows you to define your preferred technologies, patterns, and standa
 
 **Learning and Evolution**: As you work on projects, add discoveries to your preferences file:
 
-```markdown
 ## Lessons Learned
+
 - Avoid using Library X for large datasets (performance issues)
 - Pattern Y works well for real-time features
 - Service Z has excellent documentation and support
 
 ## Future Exploration
+
 - Want to try Framework A on next appropriate project
 - Interested in Pattern B for microservices
 - Consider Service C for better performance
-`````
-
-````
 
-#### Using with Web Bundles
+### Using with Web Bundles
 
 When creating custom web bundles or uploading to AI platforms, include your `technical-preferences.md` content to ensure agents have your preferences from the start of any conversation.
 
@@ -1050,4 +1036,3 @@ Remember: BMAD is designed to enhance your development process, not replace your
 ---
 
 For additional support, join our [Discord community](https://discord.gg/g6ypHytrCB) or check out the [YouTube channel](https://www.youtube.com/@BMadCode) for video tutorials and walkthroughs.
-````