bmad-method 4.24.0 → 4.24.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/settings.json +11 -5
- package/CHANGELOG.md +17 -1
- package/README.md +1 -1
- package/bmad-core/agents/bmad-master.md +1 -1
- package/bmad-core/agents/dev.md +2 -2
- package/bmad-core/agents/pm.md +1 -1
- package/bmad-core/agents/po.md +1 -1
- package/bmad-core/{core-config.yml → core-config.yaml} +1 -1
- package/bmad-core/data/bmad-kb.md +4 -4
- package/bmad-core/tasks/create-brownfield-story.md +1 -1
- package/bmad-core/tasks/create-next-story.md +4 -4
- package/bmad-core/tasks/shard-doc.md +3 -3
- package/bmad-core/tasks/update-workflow-plan.md +1 -1
- package/bmad-core/templates/architecture-tmpl.md +1 -1
- package/bmad-core/templates/fullstack-architecture-tmpl.md +3 -3
- package/bmad-core/utils/plan-management.md +1 -1
- package/common/tasks/create-doc.md +1 -1
- package/dist/agents/analyst.txt +5 -5
- package/dist/agents/architect.txt +5 -5
- package/dist/agents/bmad-master.txt +18 -18
- package/dist/agents/bmad-orchestrator.txt +7 -7
- package/dist/agents/dev.txt +1 -1
- package/dist/agents/pm.txt +4 -4
- package/dist/agents/po.txt +3 -3
- package/dist/agents/sm.txt +4 -4
- package/dist/agents/ux-expert.txt +1 -1
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +1 -1
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +3 -3
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +10 -10
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +2 -2
- package/dist/teams/team-all.txt +19 -19
- package/dist/teams/team-fullstack.txt +14 -14
- package/dist/teams/team-ide-minimal.txt +15 -15
- package/dist/teams/team-no-ui.txt +14 -14
- package/docs/agentic-tools/roo-code-guide.md +1 -1
- package/docs/core-architecture.md +12 -12
- package/docs/user-guide.md +6 -6
- package/expansion-packs/bmad-2d-phaser-game-dev/{config.yml → config.yaml} +1 -1
- package/expansion-packs/bmad-creator-tools/{config.yml → config.yaml} +1 -1
- package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +9 -9
- package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.md +1 -1
- package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/README.md +3 -3
- package/expansion-packs/bmad-infrastructure-devops/{config.yml → config.yaml} +1 -1
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
- package/package.json +1 -1
- package/tools/builders/web-builder.js +19 -20
- package/tools/bump-all-versions.js +2 -2
- package/tools/bump-core-version.js +1 -1
- package/tools/bump-expansion-version.js +1 -1
- package/tools/installer/README.md +1 -1
- package/tools/installer/bin/bmad.js +2 -2
- package/tools/installer/lib/config-loader.js +13 -12
- package/tools/installer/lib/file-manager.js +5 -5
- package/tools/installer/lib/ide-setup.js +14 -13
- package/tools/installer/lib/installer.js +24 -26
- package/tools/installer/package.json +1 -1
- package/tools/lib/dependency-resolver.js +8 -12
- package/tools/lib/yaml-utils.js +29 -0
- package/tools/update-expansion-version.js +3 -3
- package/tools/yaml-format.js +1 -1
- /package/.github/{FUNDING.yml → FUNDING.yaml} +0 -0
- /package/.github/workflows/{release.yml → release.yaml} +0 -0
- /package/bmad-core/agent-teams/{team-all.yml → team-all.yaml} +0 -0
- /package/bmad-core/agent-teams/{team-fullstack.yml → team-fullstack.yaml} +0 -0
- /package/bmad-core/agent-teams/{team-ide-minimal.yml → team-ide-minimal.yaml} +0 -0
- /package/bmad-core/agent-teams/{team-no-ui.yml → team-no-ui.yaml} +0 -0
- /package/bmad-core/workflows/{brownfield-fullstack.yml → brownfield-fullstack.yaml} +0 -0
- /package/bmad-core/workflows/{brownfield-service.yml → brownfield-service.yaml} +0 -0
- /package/bmad-core/workflows/{brownfield-ui.yml → brownfield-ui.yaml} +0 -0
- /package/bmad-core/workflows/{greenfield-fullstack.yml → greenfield-fullstack.yaml} +0 -0
- /package/bmad-core/workflows/{greenfield-service.yml → greenfield-service.yaml} +0 -0
- /package/bmad-core/workflows/{greenfield-ui.yml → greenfield-ui.yaml} +0 -0
- /package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/{phaser-2d-nodejs-game-team.yml → phaser-2d-nodejs-game-team.yaml} +0 -0
- /package/expansion-packs/bmad-2d-phaser-game-dev/workflows/{game-dev-greenfield.yml → game-dev-greenfield.yaml} +0 -0
- /package/expansion-packs/bmad-2d-phaser-game-dev/workflows/{game-prototype.yml → game-prototype.yaml} +0 -0
- /package/tools/installer/config/{ide-agent-config.yml → ide-agent-config.yaml} +0 -0
- /package/tools/installer/config/{install.config.yml → install.config.yaml} +0 -0
|
@@ -586,7 +586,7 @@ IMPORTANT: Only proceed after plan.md is approved
|
|
|
586
586
|
expansion-packs/
|
|
587
587
|
└── {pack-name}/
|
|
588
588
|
├── plan.md (ALREADY CREATED)
|
|
589
|
-
├── manifest.
|
|
589
|
+
├── manifest.yaml
|
|
590
590
|
├── README.md
|
|
591
591
|
├── agents/
|
|
592
592
|
│ ├── {pack-name}-orchestrator.md (REQUIRED - Custom themed orchestrator)
|
|
@@ -609,13 +609,13 @@ expansion-packs/
|
|
|
609
609
|
├── workflows/
|
|
610
610
|
│ └── {domain}-workflow.md (REQUIRED if multiple agents)
|
|
611
611
|
└── agent-teams/
|
|
612
|
-
└── {domain}-team.
|
|
612
|
+
└── {domain}-team.yaml (REQUIRED if multiple agents)
|
|
613
613
|
|
|
614
614
|
```
|
|
615
615
|
|
|
616
616
|
#### 3.2 Create Manifest
|
|
617
617
|
|
|
618
|
-
Create `manifest.
|
|
618
|
+
Create `manifest.yaml`:
|
|
619
619
|
|
|
620
620
|
```yaml
|
|
621
621
|
name: {pack-name}
|
|
@@ -658,7 +658,7 @@ files:
|
|
|
658
658
|
- {domain}-workflow.md # REQUIRED if multiple agents - decision trees
|
|
659
659
|
|
|
660
660
|
agent-teams:
|
|
661
|
-
- {domain}-team.
|
|
661
|
+
- {domain}-team.yaml # REQUIRED if multiple agents - team config
|
|
662
662
|
|
|
663
663
|
# Data files users must provide (in their bmad-core/data/ directory)
|
|
664
664
|
required_user_data:
|
|
@@ -794,7 +794,7 @@ cp common/utils/workflow-management.md expansion-packs/{pack-name}/utils/
|
|
|
794
794
|
1. Design decision trees for workflow branching
|
|
795
795
|
2. Create handoff protocols to specialist agents
|
|
796
796
|
3. Implement validation loops and quality checkpoints
|
|
797
|
-
4. **If multiple agents**: Create team configuration in `agent-teams/{domain}-team.
|
|
797
|
+
4. **If multiple agents**: Create team configuration in `agent-teams/{domain}-team.yaml`
|
|
798
798
|
5. **If multiple agents**: Create workflow in `workflows/{domain}-workflow.md`
|
|
799
799
|
6. Ensure orchestrator references workflow-management utility
|
|
800
800
|
7. Verify ALL referenced tasks exist (including core utilities)
|
|
@@ -965,7 +965,7 @@ Before declaring complete:
|
|
|
965
965
|
|
|
966
966
|
1. [ ] Decision trees and workflow orchestration complete
|
|
967
967
|
2. [ ] Knowledge base files embedded (best practices, terminology, standards)
|
|
968
|
-
3. [ ] Manifest.
|
|
968
|
+
3. [ ] Manifest.yaml reflects all components and dependencies
|
|
969
969
|
4. [ ] All items in plan.md marked complete
|
|
970
970
|
5. [ ] No orphaned tasks or templates
|
|
971
971
|
|
|
@@ -1072,7 +1072,7 @@ These files are automatically available to all agents and don't require user set
|
|
|
1072
1072
|
```text
|
|
1073
1073
|
healthcare/
|
|
1074
1074
|
├── plan.md (Created first for approval)
|
|
1075
|
-
├── manifest.
|
|
1075
|
+
├── manifest.yaml (with dependency mapping and character descriptions)
|
|
1076
1076
|
├── README.md (featuring character introductions and numbered options)
|
|
1077
1077
|
├── agents/
|
|
1078
1078
|
│ ├── healthcare-orchestrator.md (Dr. Sarah Chen - YAML-in-Markdown)
|
|
@@ -1098,7 +1098,7 @@ healthcare/
|
|
|
1098
1098
|
│ ├── clinical-trial-workflow.md (decision trees with Mermaid diagrams)
|
|
1099
1099
|
│ └── compliance-audit-workflow.md (handoff protocols and quality gates)
|
|
1100
1100
|
└── agent-teams/
|
|
1101
|
-
└── healthcare-team.
|
|
1101
|
+
└── healthcare-team.yaml (coordinated team configurations)
|
|
1102
1102
|
|
|
1103
1103
|
Required user data files (bmad-core/data/):
|
|
1104
1104
|
- medical-terminology.md (institution-specific terms and abbreviations)
|
|
@@ -1309,7 +1309,7 @@ Embedded knowledge (automatic):
|
|
|
1309
1309
|
- [ ] All agent references verified (tasks, templates, data, checklists)
|
|
1310
1310
|
- [ ] Data requirements documented with validation criteria and examples
|
|
1311
1311
|
- [ ] README includes character introductions and numbered options explanation
|
|
1312
|
-
- [ ] manifest.
|
|
1312
|
+
- [ ] manifest.yaml reflects actual files with dependency mapping and character descriptions
|
|
1313
1313
|
|
|
1314
1314
|
**Advanced Quality Gates:**
|
|
1315
1315
|
|
|
@@ -1732,7 +1732,7 @@ Present these numbered options to the user:
|
|
|
1732
1732
|
|
|
1733
1733
|
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
1734
1734
|
|
|
1735
|
-
```
|
|
1735
|
+
```yaml
|
|
1736
1736
|
activation-instructions:
|
|
1737
1737
|
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
1738
1738
|
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
@@ -118,7 +118,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
118
118
|
|
|
119
119
|
### 0. Check Workflow Plan (if configured)
|
|
120
120
|
|
|
121
|
-
[[LLM: Check if plan tracking is enabled in core-config.
|
|
121
|
+
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
|
122
122
|
|
|
123
123
|
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
|
124
124
|
- If plan exists and this document creation is part of the plan:
|
|
@@ -1300,7 +1300,7 @@ kind: ConfigMap
|
|
|
1300
1300
|
metadata:
|
|
1301
1301
|
name: prometheus-config
|
|
1302
1302
|
data:
|
|
1303
|
-
prometheus.
|
|
1303
|
+
prometheus.yaml: |
|
|
1304
1304
|
global:
|
|
1305
1305
|
scrape_interval: {{scrape_interval}}
|
|
1306
1306
|
scrape_configs:
|
package/dist/teams/team-all.txt
CHANGED
|
@@ -337,7 +337,7 @@ agent:
|
|
|
337
337
|
customization: null
|
|
338
338
|
startup:
|
|
339
339
|
- Announce: Greet the user with your name and role, and inform of the *help command.
|
|
340
|
-
- CRITICAL: Load .bmad-core/core-config.
|
|
340
|
+
- CRITICAL: Load .bmad-core/core-config.yaml and read devLoadAlwaysFiles list and devDebugLog values
|
|
341
341
|
- CRITICAL: Load ONLY files specified in devLoadAlwaysFiles. If any missing, inform user but continue
|
|
342
342
|
- CRITICAL: Do NOT load any story files during startup unless user requested you do
|
|
343
343
|
- CRITICAL: Do NOT begin development until told to proceed
|
|
@@ -782,7 +782,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
782
782
|
|
|
783
783
|
### 0. Check Workflow Plan (if configured)
|
|
784
784
|
|
|
785
|
-
[[LLM: Check if plan tracking is enabled in core-config.
|
|
785
|
+
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
|
786
786
|
|
|
787
787
|
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
|
788
788
|
- If plan exists and this document creation is part of the plan:
|
|
@@ -1234,7 +1234,7 @@ Update the status of steps in an active workflow plan, mark completions, add not
|
|
|
1234
1234
|
|
|
1235
1235
|
### 0. Load Plan Configuration
|
|
1236
1236
|
|
|
1237
|
-
[[LLM: First load core-config.
|
|
1237
|
+
[[LLM: First load core-config.yaml to get plan settings]]
|
|
1238
1238
|
|
|
1239
1239
|
Check workflow configuration:
|
|
1240
1240
|
|
|
@@ -1638,11 +1638,11 @@ npx bmad-method install
|
|
|
1638
1638
|
5. **MUST switch to Dev agent** for implementation
|
|
1639
1639
|
6. Keep planning and coding in separate chat sessions
|
|
1640
1640
|
|
|
1641
|
-
## Core Configuration (core-config.
|
|
1641
|
+
## Core Configuration (core-config.yaml)
|
|
1642
1642
|
|
|
1643
|
-
**New in V4**: The `bmad-core/core-config.
|
|
1643
|
+
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
1644
1644
|
|
|
1645
|
-
### What is core-config.
|
|
1645
|
+
### What is core-config.yaml?
|
|
1646
1646
|
|
|
1647
1647
|
This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
|
1648
1648
|
|
|
@@ -1814,7 +1814,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
1814
1814
|
|
|
1815
1815
|
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
1816
1816
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
1817
|
-
- **Examples**: `team-all.
|
|
1817
|
+
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
|
1818
1818
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
1819
1819
|
|
|
1820
1820
|
#### 3. Workflows (`bmad-core/workflows/`)
|
|
@@ -2242,7 +2242,7 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
|
|
2242
2242
|
```
|
|
2243
2243
|
Check for workflow plan:
|
|
2244
2244
|
1. Look for docs/workflow-plan.md (default location)
|
|
2245
|
-
2. Check core-config.
|
|
2245
|
+
2. Check core-config.yaml for custom plan location
|
|
2246
2246
|
3. Return plan status (exists/not exists)
|
|
2247
2247
|
```
|
|
2248
2248
|
|
|
@@ -4706,7 +4706,7 @@ After presenting the structure, apply `tasks#advanced-elicitation` protocol to r
|
|
|
4706
4706
|
{{project-root}}/
|
|
4707
4707
|
├── .github/ # CI/CD workflows
|
|
4708
4708
|
│ └── workflows/
|
|
4709
|
-
│ └── main.
|
|
4709
|
+
│ └── main.yaml
|
|
4710
4710
|
├── .vscode/ # VSCode settings (optional)
|
|
4711
4711
|
│ └── settings.json
|
|
4712
4712
|
├── build/ # Compiled output (git-ignored)
|
|
@@ -5555,7 +5555,7 @@ Use appropriate format for the chosen API style. If no API (e.g., static site),
|
|
|
5555
5555
|
|
|
5556
5556
|
^^CONDITION: has_rest_api^^
|
|
5557
5557
|
|
|
5558
|
-
```
|
|
5558
|
+
```yaml
|
|
5559
5559
|
openapi: 3.0.0
|
|
5560
5560
|
info:
|
|
5561
5561
|
title:
|
|
@@ -5911,8 +5911,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|
|
5911
5911
|
{{project-name}}/
|
|
5912
5912
|
├── .github/ # CI/CD workflows
|
|
5913
5913
|
│ └── workflows/
|
|
5914
|
-
│ ├── ci.
|
|
5915
|
-
│ └── deploy.
|
|
5914
|
+
│ ├── ci.yaml
|
|
5915
|
+
│ └── deploy.yaml
|
|
5916
5916
|
├── apps/ # Application packages
|
|
5917
5917
|
│ ├── web/ # Frontend application
|
|
5918
5918
|
│ │ ├── src/
|
|
@@ -7788,20 +7788,20 @@ The story creation is successful when:
|
|
|
7788
7788
|
|
|
7789
7789
|
## Primary Method: Automatic with markdown-tree
|
|
7790
7790
|
|
|
7791
|
-
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.
|
|
7791
|
+
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
7792
7792
|
|
|
7793
7793
|
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
7794
7794
|
|
|
7795
7795
|
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
|
7796
7796
|
|
|
7797
7797
|
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
7798
|
-
2. Or set markdownExploder to false in bmad-core/core-config.
|
|
7798
|
+
2. Or set markdownExploder to false in bmad-core/core-config.yaml
|
|
7799
7799
|
|
|
7800
7800
|
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
7801
7801
|
|
|
7802
7802
|
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
7803
7803
|
|
|
7804
|
-
1. Set markdownExploder to true in bmad-core/core-config.
|
|
7804
|
+
1. Set markdownExploder to true in bmad-core/core-config.yaml
|
|
7805
7805
|
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
7806
7806
|
|
|
7807
7807
|
I will now proceed with the manual sharding process."
|
|
@@ -9675,12 +9675,12 @@ To identify the next logical story based on project progress and epic definition
|
|
|
9675
9675
|
|
|
9676
9676
|
[[LLM: CRITICAL - This MUST be your first step]]
|
|
9677
9677
|
|
|
9678
|
-
- Load `.bmad-core/core-config.
|
|
9678
|
+
- Load `.bmad-core/core-config.yaml` from the project root
|
|
9679
9679
|
- If the file does not exist:
|
|
9680
|
-
- HALT and inform the user: "core-config.
|
|
9681
|
-
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.
|
|
9680
|
+
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
|
9681
|
+
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
|
9682
9682
|
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
|
9683
|
-
Please add and configure core-config.
|
|
9683
|
+
Please add and configure core-config.yaml before proceeding."
|
|
9684
9684
|
- Extract the following key configurations:
|
|
9685
9685
|
- `devStoryLocation`: Where to save story files
|
|
9686
9686
|
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
@@ -626,7 +626,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
626
626
|
|
|
627
627
|
### 0. Check Workflow Plan (if configured)
|
|
628
628
|
|
|
629
|
-
[[LLM: Check if plan tracking is enabled in core-config.
|
|
629
|
+
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
|
630
630
|
|
|
631
631
|
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
|
632
632
|
- If plan exists and this document creation is part of the plan:
|
|
@@ -1078,7 +1078,7 @@ Update the status of steps in an active workflow plan, mark completions, add not
|
|
|
1078
1078
|
|
|
1079
1079
|
### 0. Load Plan Configuration
|
|
1080
1080
|
|
|
1081
|
-
[[LLM: First load core-config.
|
|
1081
|
+
[[LLM: First load core-config.yaml to get plan settings]]
|
|
1082
1082
|
|
|
1083
1083
|
Check workflow configuration:
|
|
1084
1084
|
|
|
@@ -1482,11 +1482,11 @@ npx bmad-method install
|
|
|
1482
1482
|
5. **MUST switch to Dev agent** for implementation
|
|
1483
1483
|
6. Keep planning and coding in separate chat sessions
|
|
1484
1484
|
|
|
1485
|
-
## Core Configuration (core-config.
|
|
1485
|
+
## Core Configuration (core-config.yaml)
|
|
1486
1486
|
|
|
1487
|
-
**New in V4**: The `bmad-core/core-config.
|
|
1487
|
+
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
1488
1488
|
|
|
1489
|
-
### What is core-config.
|
|
1489
|
+
### What is core-config.yaml?
|
|
1490
1490
|
|
|
1491
1491
|
This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
|
1492
1492
|
|
|
@@ -1658,7 +1658,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
1658
1658
|
|
|
1659
1659
|
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
1660
1660
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
1661
|
-
- **Examples**: `team-all.
|
|
1661
|
+
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
|
1662
1662
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
1663
1663
|
|
|
1664
1664
|
#### 3. Workflows (`bmad-core/workflows/`)
|
|
@@ -2086,7 +2086,7 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
|
|
2086
2086
|
```
|
|
2087
2087
|
Check for workflow plan:
|
|
2088
2088
|
1. Look for docs/workflow-plan.md (default location)
|
|
2089
|
-
2. Check core-config.
|
|
2089
|
+
2. Check core-config.yaml for custom plan location
|
|
2090
2090
|
3. Return plan status (exists/not exists)
|
|
2091
2091
|
```
|
|
2092
2092
|
|
|
@@ -4551,20 +4551,20 @@ The LLM will:
|
|
|
4551
4551
|
|
|
4552
4552
|
## Primary Method: Automatic with markdown-tree
|
|
4553
4553
|
|
|
4554
|
-
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.
|
|
4554
|
+
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
4555
4555
|
|
|
4556
4556
|
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
4557
4557
|
|
|
4558
4558
|
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
|
4559
4559
|
|
|
4560
4560
|
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
4561
|
-
2. Or set markdownExploder to false in bmad-core/core-config.
|
|
4561
|
+
2. Or set markdownExploder to false in bmad-core/core-config.yaml
|
|
4562
4562
|
|
|
4563
4563
|
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
4564
4564
|
|
|
4565
4565
|
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
4566
4566
|
|
|
4567
|
-
1. Set markdownExploder to true in bmad-core/core-config.
|
|
4567
|
+
1. Set markdownExploder to true in bmad-core/core-config.yaml
|
|
4568
4568
|
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
4569
4569
|
|
|
4570
4570
|
I will now proceed with the manual sharding process."
|
|
@@ -6646,7 +6646,7 @@ After presenting the structure, apply `tasks#advanced-elicitation` protocol to r
|
|
|
6646
6646
|
{{project-root}}/
|
|
6647
6647
|
├── .github/ # CI/CD workflows
|
|
6648
6648
|
│ └── workflows/
|
|
6649
|
-
│ └── main.
|
|
6649
|
+
│ └── main.yaml
|
|
6650
6650
|
├── .vscode/ # VSCode settings (optional)
|
|
6651
6651
|
│ └── settings.json
|
|
6652
6652
|
├── build/ # Compiled output (git-ignored)
|
|
@@ -7495,7 +7495,7 @@ Use appropriate format for the chosen API style. If no API (e.g., static site),
|
|
|
7495
7495
|
|
|
7496
7496
|
^^CONDITION: has_rest_api^^
|
|
7497
7497
|
|
|
7498
|
-
```
|
|
7498
|
+
```yaml
|
|
7499
7499
|
openapi: 3.0.0
|
|
7500
7500
|
info:
|
|
7501
7501
|
title:
|
|
@@ -7851,8 +7851,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|
|
7851
7851
|
{{project-name}}/
|
|
7852
7852
|
├── .github/ # CI/CD workflows
|
|
7853
7853
|
│ └── workflows/
|
|
7854
|
-
│ ├── ci.
|
|
7855
|
-
│ └── deploy.
|
|
7854
|
+
│ ├── ci.yaml
|
|
7855
|
+
│ └── deploy.yaml
|
|
7856
7856
|
├── apps/ # Application packages
|
|
7857
7857
|
│ ├── web/ # Frontend application
|
|
7858
7858
|
│ │ ├── src/
|
|
@@ -319,7 +319,7 @@ agent:
|
|
|
319
319
|
customization: null
|
|
320
320
|
startup:
|
|
321
321
|
- Announce: Greet the user with your name and role, and inform of the *help command.
|
|
322
|
-
- CRITICAL: Load .bmad-core/core-config.
|
|
322
|
+
- CRITICAL: Load .bmad-core/core-config.yaml and read devLoadAlwaysFiles list and devDebugLog values
|
|
323
323
|
- CRITICAL: Load ONLY files specified in devLoadAlwaysFiles. If any missing, inform user but continue
|
|
324
324
|
- CRITICAL: Do NOT load any story files during startup unless user requested you do
|
|
325
325
|
- CRITICAL: Do NOT begin development until told to proceed
|
|
@@ -526,7 +526,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
526
526
|
|
|
527
527
|
### 0. Check Workflow Plan (if configured)
|
|
528
528
|
|
|
529
|
-
[[LLM: Check if plan tracking is enabled in core-config.
|
|
529
|
+
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
|
530
530
|
|
|
531
531
|
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
|
532
532
|
- If plan exists and this document creation is part of the plan:
|
|
@@ -978,7 +978,7 @@ Update the status of steps in an active workflow plan, mark completions, add not
|
|
|
978
978
|
|
|
979
979
|
### 0. Load Plan Configuration
|
|
980
980
|
|
|
981
|
-
[[LLM: First load core-config.
|
|
981
|
+
[[LLM: First load core-config.yaml to get plan settings]]
|
|
982
982
|
|
|
983
983
|
Check workflow configuration:
|
|
984
984
|
|
|
@@ -1382,11 +1382,11 @@ npx bmad-method install
|
|
|
1382
1382
|
5. **MUST switch to Dev agent** for implementation
|
|
1383
1383
|
6. Keep planning and coding in separate chat sessions
|
|
1384
1384
|
|
|
1385
|
-
## Core Configuration (core-config.
|
|
1385
|
+
## Core Configuration (core-config.yaml)
|
|
1386
1386
|
|
|
1387
|
-
**New in V4**: The `bmad-core/core-config.
|
|
1387
|
+
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
1388
1388
|
|
|
1389
|
-
### What is core-config.
|
|
1389
|
+
### What is core-config.yaml?
|
|
1390
1390
|
|
|
1391
1391
|
This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
|
1392
1392
|
|
|
@@ -1558,7 +1558,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
1558
1558
|
|
|
1559
1559
|
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
1560
1560
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
1561
|
-
- **Examples**: `team-all.
|
|
1561
|
+
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
|
1562
1562
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
1563
1563
|
|
|
1564
1564
|
#### 3. Workflows (`bmad-core/workflows/`)
|
|
@@ -1986,7 +1986,7 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
|
|
1986
1986
|
```
|
|
1987
1987
|
Check for workflow plan:
|
|
1988
1988
|
1. Look for docs/workflow-plan.md (default location)
|
|
1989
|
-
2. Check core-config.
|
|
1989
|
+
2. Check core-config.yaml for custom plan location
|
|
1990
1990
|
3. Return plan status (exists/not exists)
|
|
1991
1991
|
```
|
|
1992
1992
|
|
|
@@ -2404,20 +2404,20 @@ The LLM will:
|
|
|
2404
2404
|
|
|
2405
2405
|
## Primary Method: Automatic with markdown-tree
|
|
2406
2406
|
|
|
2407
|
-
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.
|
|
2407
|
+
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
2408
2408
|
|
|
2409
2409
|
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
2410
2410
|
|
|
2411
2411
|
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
|
2412
2412
|
|
|
2413
2413
|
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
2414
|
-
2. Or set markdownExploder to false in bmad-core/core-config.
|
|
2414
|
+
2. Or set markdownExploder to false in bmad-core/core-config.yaml
|
|
2415
2415
|
|
|
2416
2416
|
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
2417
2417
|
|
|
2418
2418
|
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
2419
2419
|
|
|
2420
|
-
1. Set markdownExploder to true in bmad-core/core-config.
|
|
2420
|
+
1. Set markdownExploder to true in bmad-core/core-config.yaml
|
|
2421
2421
|
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
2422
2422
|
|
|
2423
2423
|
I will now proceed with the manual sharding process."
|
|
@@ -3690,12 +3690,12 @@ To identify the next logical story based on project progress and epic definition
|
|
|
3690
3690
|
|
|
3691
3691
|
[[LLM: CRITICAL - This MUST be your first step]]
|
|
3692
3692
|
|
|
3693
|
-
- Load `.bmad-core/core-config.
|
|
3693
|
+
- Load `.bmad-core/core-config.yaml` from the project root
|
|
3694
3694
|
- If the file does not exist:
|
|
3695
|
-
- HALT and inform the user: "core-config.
|
|
3696
|
-
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.
|
|
3695
|
+
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
|
3696
|
+
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
|
3697
3697
|
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
|
3698
|
-
Please add and configure core-config.
|
|
3698
|
+
Please add and configure core-config.yaml before proceeding."
|
|
3699
3699
|
- Extract the following key configurations:
|
|
3700
3700
|
- `devStoryLocation`: Where to save story files
|
|
3701
3701
|
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
@@ -558,7 +558,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
558
558
|
|
|
559
559
|
### 0. Check Workflow Plan (if configured)
|
|
560
560
|
|
|
561
|
-
[[LLM: Check if plan tracking is enabled in core-config.
|
|
561
|
+
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
|
562
562
|
|
|
563
563
|
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
|
564
564
|
- If plan exists and this document creation is part of the plan:
|
|
@@ -1010,7 +1010,7 @@ Update the status of steps in an active workflow plan, mark completions, add not
|
|
|
1010
1010
|
|
|
1011
1011
|
### 0. Load Plan Configuration
|
|
1012
1012
|
|
|
1013
|
-
[[LLM: First load core-config.
|
|
1013
|
+
[[LLM: First load core-config.yaml to get plan settings]]
|
|
1014
1014
|
|
|
1015
1015
|
Check workflow configuration:
|
|
1016
1016
|
|
|
@@ -1414,11 +1414,11 @@ npx bmad-method install
|
|
|
1414
1414
|
5. **MUST switch to Dev agent** for implementation
|
|
1415
1415
|
6. Keep planning and coding in separate chat sessions
|
|
1416
1416
|
|
|
1417
|
-
## Core Configuration (core-config.
|
|
1417
|
+
## Core Configuration (core-config.yaml)
|
|
1418
1418
|
|
|
1419
|
-
**New in V4**: The `bmad-core/core-config.
|
|
1419
|
+
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
1420
1420
|
|
|
1421
|
-
### What is core-config.
|
|
1421
|
+
### What is core-config.yaml?
|
|
1422
1422
|
|
|
1423
1423
|
This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
|
1424
1424
|
|
|
@@ -1590,7 +1590,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
1590
1590
|
|
|
1591
1591
|
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
1592
1592
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
1593
|
-
- **Examples**: `team-all.
|
|
1593
|
+
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
|
1594
1594
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
1595
1595
|
|
|
1596
1596
|
#### 3. Workflows (`bmad-core/workflows/`)
|
|
@@ -2018,7 +2018,7 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
|
|
2018
2018
|
```
|
|
2019
2019
|
Check for workflow plan:
|
|
2020
2020
|
1. Look for docs/workflow-plan.md (default location)
|
|
2021
|
-
2. Check core-config.
|
|
2021
|
+
2. Check core-config.yaml for custom plan location
|
|
2022
2022
|
3. Return plan status (exists/not exists)
|
|
2023
2023
|
```
|
|
2024
2024
|
|
|
@@ -4483,20 +4483,20 @@ The LLM will:
|
|
|
4483
4483
|
|
|
4484
4484
|
## Primary Method: Automatic with markdown-tree
|
|
4485
4485
|
|
|
4486
|
-
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.
|
|
4486
|
+
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
4487
4487
|
|
|
4488
4488
|
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
4489
4489
|
|
|
4490
4490
|
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
|
4491
4491
|
|
|
4492
4492
|
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
4493
|
-
2. Or set markdownExploder to false in bmad-core/core-config.
|
|
4493
|
+
2. Or set markdownExploder to false in bmad-core/core-config.yaml
|
|
4494
4494
|
|
|
4495
4495
|
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
4496
4496
|
|
|
4497
4497
|
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
4498
4498
|
|
|
4499
|
-
1. Set markdownExploder to true in bmad-core/core-config.
|
|
4499
|
+
1. Set markdownExploder to true in bmad-core/core-config.yaml
|
|
4500
4500
|
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
4501
4501
|
|
|
4502
4502
|
I will now proceed with the manual sharding process."
|
|
@@ -6108,7 +6108,7 @@ After presenting the structure, apply `tasks#advanced-elicitation` protocol to r
|
|
|
6108
6108
|
{{project-root}}/
|
|
6109
6109
|
├── .github/ # CI/CD workflows
|
|
6110
6110
|
│ └── workflows/
|
|
6111
|
-
│ └── main.
|
|
6111
|
+
│ └── main.yaml
|
|
6112
6112
|
├── .vscode/ # VSCode settings (optional)
|
|
6113
6113
|
│ └── settings.json
|
|
6114
6114
|
├── build/ # Compiled output (git-ignored)
|
|
@@ -6957,7 +6957,7 @@ Use appropriate format for the chosen API style. If no API (e.g., static site),
|
|
|
6957
6957
|
|
|
6958
6958
|
^^CONDITION: has_rest_api^^
|
|
6959
6959
|
|
|
6960
|
-
```
|
|
6960
|
+
```yaml
|
|
6961
6961
|
openapi: 3.0.0
|
|
6962
6962
|
info:
|
|
6963
6963
|
title:
|
|
@@ -7313,8 +7313,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|
|
7313
7313
|
{{project-name}}/
|
|
7314
7314
|
├── .github/ # CI/CD workflows
|
|
7315
7315
|
│ └── workflows/
|
|
7316
|
-
│ ├── ci.
|
|
7317
|
-
│ └── deploy.
|
|
7316
|
+
│ ├── ci.yaml
|
|
7317
|
+
│ └── deploy.yaml
|
|
7318
7318
|
├── apps/ # Application packages
|
|
7319
7319
|
│ ├── web/ # Frontend application
|
|
7320
7320
|
│ │ ├── src/
|
|
@@ -33,7 +33,7 @@ Select mode from the mode selector (usually in status bar):
|
|
|
33
33
|
### File Permission Summary
|
|
34
34
|
|
|
35
35
|
- **Documentation agents** (analyst, pm, po, sm): `.md`, `.txt` only
|
|
36
|
-
- **bmad-architect**: `.md`, `.txt`, `.
|
|
36
|
+
- **bmad-architect**: `.md`, `.txt`, `.yaml`, `.yaml`, `.json`
|
|
37
37
|
- **bmad-qa**: Test files (`.test.*`, `.spec.*`) and `.md`
|
|
38
38
|
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx`
|
|
39
39
|
- **Full access**: `bmad-dev`, `bmad-bmad-master`, `bmad-orchestrator`
|
|
@@ -75,12 +75,12 @@ The `.bmad-core` directory contains all the definitions and resources that give
|
|
|
75
75
|
|
|
76
76
|
### 3.2. Agent Teams (`.bmad-core/agent-teams/`)
|
|
77
77
|
|
|
78
|
-
- **Purpose**: Team files (e.g., `team-all.
|
|
78
|
+
- **Purpose**: Team files (e.g., `team-all.yaml`) define collections of agents and workflows that are bundled together for a specific purpose, like "full-stack development" or "backend-only". This creates a larger, pre-packaged context for web UI environments.
|
|
79
79
|
- **Structure**: A team file lists the agents to include. It can use wildcards, such as `"*"` to include all agents. This allows for the creation of comprehensive bundles like `team-all`.
|
|
80
80
|
|
|
81
81
|
### 3.3. Workflows (`.bmad-core/workflows/`)
|
|
82
82
|
|
|
83
|
-
- **Purpose**: Workflows are YAML files (e.g., `greenfield-fullstack.
|
|
83
|
+
- **Purpose**: Workflows are YAML files (e.g., `greenfield-fullstack.yaml`) that define a prescribed sequence of steps and agent interactions for a specific project type. They act as a strategic guide for the user and the `bmad-orchestrator` agent.
|
|
84
84
|
- **Structure**: A workflow defines sequences for both complex and simple projects, lists the agents involved at each step, the artifacts they create, and the conditions for moving from one step to the next. It often includes a Mermaid diagram for visualization.
|
|
85
85
|
|
|
86
86
|
### 3.4. Reusable Resources (`templates`, `tasks`, `checklists`, `data`)
|
|
@@ -239,10 +239,10 @@ bmad-method/
|
|
|
239
239
|
│ │ ├── sm.md # Scrum master agent
|
|
240
240
|
│ │ └── ux-expert.md # UX designer agent
|
|
241
241
|
│ ├── agent-teams/ # Pre-configured agent teams
|
|
242
|
-
│ │ ├── team-all.
|
|
243
|
-
│ │ ├── team-fullstack.
|
|
244
|
-
│ │ ├── team-ide-minimal.
|
|
245
|
-
│ │ └── team-no-ui.
|
|
242
|
+
│ │ ├── team-all.yaml # All agents bundle
|
|
243
|
+
│ │ ├── team-fullstack.yaml # Full-stack development team
|
|
244
|
+
│ │ ├── team-ide-minimal.yaml # Minimal IDE-focused team
|
|
245
|
+
│ │ └── team-no-ui.yaml # Backend-only team
|
|
246
246
|
│ ├── checklists/ # Quality assurance checklists
|
|
247
247
|
│ │ ├── architect-checklist.md
|
|
248
248
|
│ │ ├── po-master-checklist.md
|
|
@@ -268,11 +268,11 @@ bmad-method/
|
|
|
268
268
|
│ │ ├── template-format.md # Template markup spec
|
|
269
269
|
│ │ └── workflow-management.md # Workflow helpers
|
|
270
270
|
│ ├── workflows/ # Development workflows
|
|
271
|
-
│ │ ├── brownfield-enhancement.
|
|
272
|
-
│ │ ├── greenfield-fullstack.
|
|
273
|
-
│ │ ├── greenfield-service.
|
|
274
|
-
│ │ └── greenfield-simple.
|
|
275
|
-
│ └── core-config.
|
|
271
|
+
│ │ ├── brownfield-enhancement.yaml
|
|
272
|
+
│ │ ├── greenfield-fullstack.yaml
|
|
273
|
+
│ │ ├── greenfield-service.yaml
|
|
274
|
+
│ │ └── greenfield-simple.yaml
|
|
275
|
+
│ └── core-config.yaml # V4 configuration system
|
|
276
276
|
│
|
|
277
277
|
├── dist/ # Pre-built bundles (generated)
|
|
278
278
|
│ ├── agents/ # Individual agent bundles
|
|
@@ -378,7 +378,7 @@ bmad-method/
|
|
|
378
378
|
|
|
379
379
|
### Key Files
|
|
380
380
|
|
|
381
|
-
- **core-config.
|
|
381
|
+
- **core-config.yaml**: V4's flexible configuration system
|
|
382
382
|
- **bmad-kb.md**: Central knowledge base loaded by most agents
|
|
383
383
|
- **template-format.md**: Specification for BMAD's template markup
|
|
384
384
|
- **dependency-resolver.js**: Manages agent resource loading
|
package/docs/user-guide.md
CHANGED
|
@@ -104,7 +104,7 @@ After upgrading:
|
|
|
104
104
|
2. Optionally run the `doc-migration-task` to align your documents with V4 templates - you can do this with your agent by saying something like: 'run {drag in task} against {drag prd or arch file from docs} to align with {drag the template from .bmad-core/templates/full-stack-architecture.md}'
|
|
105
105
|
3. If you have separate front-end and backend architecture docs you can modify step 2 to merge both into a single full stack architecture or separate Front and Back end.
|
|
106
106
|
|
|
107
|
-
The reason #2 and #3 are optional is because now BMAD V4 makes sharding optional for the SM. See [Core Configuration](#core-configuration
|
|
107
|
+
The reason #2 and #3 are optional is because now BMAD V4 makes sharding optional for the SM. See [Core Configuration](#core-configuration)
|
|
108
108
|
|
|
109
109
|
**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
|
|
110
110
|
|
|
@@ -456,7 +456,7 @@ The SM agent serves as a critical bridge between high-level planning and technic
|
|
|
456
456
|
|
|
457
457
|
When the SM agent executes the `create-next-story` task:
|
|
458
458
|
|
|
459
|
-
1. **Loads Configuration**: Reads `core-config.
|
|
459
|
+
1. **Loads Configuration**: Reads `core-config.yaml` to understand project structure
|
|
460
460
|
2. **Identifies Next Story**: Sequentially processes stories from epics (1.1, 1.2, 2.1, etc.)
|
|
461
461
|
3. **Gathers Architecture Context**: Reads relevant sharded architecture documents based on story type:
|
|
462
462
|
|
|
@@ -1131,11 +1131,11 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|
|
1131
1131
|
|
|
1132
1132
|
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.
|
|
1133
1133
|
|
|
1134
|
-
### Core Configuration
|
|
1134
|
+
### Core Configuration
|
|
1135
1135
|
|
|
1136
|
-
The `bmad-core/core-config.
|
|
1136
|
+
The `bmad-core/core-config.yaml` file is a critical V4 innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
1137
1137
|
|
|
1138
|
-
#### Understanding core-config.
|
|
1138
|
+
#### Understanding core-config.yaml
|
|
1139
1139
|
|
|
1140
1140
|
This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It's what makes V4 agents intelligent enough to work with V3 projects, custom layouts, or any document organization you prefer.
|
|
1141
1141
|
|
|
@@ -1350,7 +1350,7 @@ customTechnicalDocuments:
|
|
|
1350
1350
|
1. **Always Configure for Your Structure**: Don't force your project to match BMAD defaults
|
|
1351
1351
|
2. **Keep devLoadAlwaysFiles Focused**: Only include files needed for every dev task
|
|
1352
1352
|
3. **Use Debug Log**: Enable when troubleshooting story implementation issues
|
|
1353
|
-
4. **Version Control core-config.
|
|
1353
|
+
4. **Version Control core-config.yaml**: Track changes to understand project evolution
|
|
1354
1354
|
5. **Document Custom Patterns**: If using custom epicFilePattern, document it
|
|
1355
1355
|
|
|
1356
1356
|
#### Troubleshooting
|