mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
Merge branch 'main' into fix/issue-1088-remove-stale-workflow-refs
This commit is contained in:
@@ -661,14 +661,14 @@ You can customize any agent's personality without modifying core agent files.
|
||||
|
||||
### Location
|
||||
|
||||
**Customization Directory:** `{project-root}/{bmad_folder}/_cfg/agents/`
|
||||
**Customization Directory:** `{project-root}/.bmad/_cfg/agents/`
|
||||
|
||||
**Naming Convention:** `{module}-{agent-name}.customize.yaml`
|
||||
|
||||
**Examples:**
|
||||
|
||||
```
|
||||
{bmad_folder}/_cfg/agents/
|
||||
.bmad/_cfg/agents/
|
||||
├── bmm-pm.customize.yaml
|
||||
├── bmm-dev.customize.yaml
|
||||
├── cis-storyteller.customize.yaml
|
||||
@@ -768,9 +768,9 @@ Other agents collaborate with PM's specialized perspective.
|
||||
|
||||
```bash
|
||||
# Create customization file at:
|
||||
# {project-root}/{bmad_folder}/_cfg/agents/{module}-{agent-name}.customize.yaml
|
||||
# {project-root}/.bmad/_cfg/agents/{module}-{agent-name}.customize.yaml
|
||||
|
||||
# Example: {bmad_folder}/_cfg/agents/bmm-pm.customize.yaml
|
||||
# Example: .bmad/_cfg/agents/bmm-pm.customize.yaml
|
||||
```
|
||||
|
||||
**Step 2: Regenerate Agent Manifest**
|
||||
|
||||
@@ -137,7 +137,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
|
||||
```bash
|
||||
# Load BMad Master or any agent
|
||||
{bmad_folder}/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
.bmad/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
```
|
||||
|
||||
- Splits on level 2 sections by default
|
||||
@@ -147,7 +147,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
2. **Then:** Run `index-docs` task to create navigation:
|
||||
|
||||
```bash
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
.bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated → Run `document-project`
|
||||
@@ -210,7 +210,7 @@ If you have **good, current documentation** but it's in massive files:
|
||||
|
||||
```bash
|
||||
# For each massive doc (>500 lines or 10+ level 2 sections)
|
||||
{bmad_folder}/core/tools/shard-doc.xml \
|
||||
.bmad/core/tools/shard-doc.xml \
|
||||
--input docs/api-documentation.md \
|
||||
--output docs/api/ \
|
||||
--level 2 # Split on ## headers (default)
|
||||
@@ -219,7 +219,7 @@ If you have **good, current documentation** but it's in massive files:
|
||||
**Step 2: Generate index**
|
||||
|
||||
```bash
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
.bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
**Step 3: Validate**
|
||||
|
||||
@@ -425,7 +425,7 @@ Team C (2 devs): Analytics feature (3 epics)
|
||||
|
||||
**Problem:** Teams customize BMad (agents, workflows, configs) but don't want personal tooling in main repo.
|
||||
|
||||
**Anti-pattern:** Adding `{bmad_folder}/` to `.gitignore` breaks IDE tools, submodule management.
|
||||
**Anti-pattern:** Adding `.bmad/` to `.gitignore` breaks IDE tools, submodule management.
|
||||
|
||||
### The Solution: Git Submodules
|
||||
|
||||
@@ -463,7 +463,7 @@ git commit -m "Add BMM as submodule"
|
||||
git clone https://github.com/your-org/your-project.git
|
||||
cd your-project
|
||||
git submodule update --init --recursive
|
||||
# Make personal customizations in {bmad_folder}/
|
||||
# Make personal customizations in .bmad/
|
||||
```
|
||||
|
||||
### Daily Workflow
|
||||
@@ -472,7 +472,7 @@ git submodule update --init --recursive
|
||||
|
||||
```bash
|
||||
cd /path/to/your-project
|
||||
# BMad available at ./{bmad_folder}/, load agents normally
|
||||
# BMad available at ./.bmad/, load agents normally
|
||||
```
|
||||
|
||||
**Update personal config:**
|
||||
|
||||
@@ -358,7 +358,7 @@ See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/do
|
||||
|
||||
### Q: Can I customize agents?
|
||||
|
||||
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `{bmad_folder}/_cfg/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `.bmad/_cfg/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
|
||||
**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags - a format any LLM can read and follow.
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and su
|
||||
|
||||
**The basics:**
|
||||
|
||||
1. Party mode reads `{bmad_folder}/_cfg/agent-manifest.csv`
|
||||
1. Party mode reads `.bmad/_cfg/agent-manifest.csv`
|
||||
2. Loads ALL installed agents (already includes your customizations from install)
|
||||
3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic
|
||||
4. Agents respond in character, can agree/disagree/build on each other's ideas
|
||||
@@ -126,11 +126,11 @@ _(Multiple perspectives reveal the right answer)_
|
||||
|
||||
## Agent Customization
|
||||
|
||||
Party mode uses agents from `{bmad_folder}/[module]/agents/*.md` - these already include any customizations you applied during install.
|
||||
Party mode uses agents from `.bmad/[module]/agents/*.md` - these already include any customizations you applied during install.
|
||||
|
||||
**To customize agents for party mode:**
|
||||
|
||||
1. Create customization file: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
|
||||
1. Create customization file: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
|
||||
2. Run `npx bmad-method install` to rebuild agents
|
||||
3. Customizations now active in party mode
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ _Complete visual flowchart showing all phases, workflows, agents (color-coded),
|
||||
npx bmad-method@alpha install
|
||||
```
|
||||
|
||||
The interactive installer will guide you through setup and create a `{bmad_folder}/` folder with all agents and workflows.
|
||||
The interactive installer will guide you through setup and create a `.bmad/` folder with all agents and workflows.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -398,7 +398,7 @@ MCP provides additional capabilities on top of TEA's default AI-based approach:
|
||||
}
|
||||
```
|
||||
|
||||
**To disable**: Set `tea_use_mcp_enhancements: false` in `{bmad_folder}/bmm/config.yaml` OR remove MCPs from IDE config.
|
||||
**To disable**: Set `tea_use_mcp_enhancements: false` in `.bmad/bmm/config.yaml` OR remove MCPs from IDE config.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -440,9 +440,9 @@ Provides fixture-based utilities that integrate into TEA's test generation and r
|
||||
|
||||
**Utilities available** (11 total): api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition
|
||||
|
||||
**Enable during BMAD installation** by answering "Yes" when prompted, or manually set `tea_use_playwright_utils: true` in `{bmad_folder}/bmm/config.yaml`.
|
||||
**Enable during BMAD installation** by answering "Yes" when prompted, or manually set `tea_use_playwright_utils: true` in `.bmad/bmm/config.yaml`.
|
||||
|
||||
**To disable**: Set `tea_use_playwright_utils: false` in `{bmad_folder}/bmm/config.yaml`.
|
||||
**To disable**: Set `tea_use_playwright_utils: false` in `.bmad/bmm/config.yaml`.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
@@ -179,7 +179,7 @@ The workflow uses a single comprehensive CSV file:
|
||||
|
||||
**documentation-requirements.csv** - Complete project analysis guide
|
||||
|
||||
- Location: `/{bmad_folder}/bmm/workflows/document-project/documentation-requirements.csv`
|
||||
- Location: `/.bmad/bmm/workflows/document-project/documentation-requirements.csv`
|
||||
- 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded)
|
||||
- 24 columns combining:
|
||||
- **Detection columns**: `project_type_id`, `key_file_patterns` (identifies project type from codebase)
|
||||
|
||||
Reference in New Issue
Block a user