ros/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-01-30 04:32:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(config): replace hardcoded .bmad paths with {bmad_folder} placeholder

Browse Source 
Remove hardcoded .bmad folder references throughout documentation and source files, replacing them with the configurable {bmad_folder} placeholder. This change enables users to customize the BMAD installation folder name via configuration, improving flexibility and reducing coupling to a specific directory structure.

Changes include:
- Update all documentation to reference {bmad_folder} instead of .bmad
- Remove legacy configuration files from .bmad and .claude directories
- Update workflow.xml and CLI documentation with new placeholder syntax
This commit is contained in:
Brian Madison
2025-11-12 20:22:47 -06:00
parent 48cf5c8056
commit 1868477238
154 changed files with 124 additions and 16290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/v4-to-v6-upgrade.md
View File

@@ -63,7 +63,7 @@ your-project/
```
your-project/
└── bmad/ # Single installation folder
└── {bmad_folder}/ # Single installation folder, default .bmad
├── core/ # Real core framework (applies to all modules)
├── bmm/ # BMad Method (software/game dev)
├── bmb/ # BMad Builder (create agents/workflows)
@@ -75,8 +75,8 @@ your-project/
### Key Concept Changes
- **v4 `.bmad-core`**: Was actually the BMad Method
- **v6 `bmad/core/`**: Is the real universal core framework
- **v6 `bmad/bmm/`**: Is the BMad Method module
- **v6 `{bmad_folder}/core/`**: Is the real universal core framework
- **v6 `{bmad_folder}/bmm/`**: Is the BMad Method module
- **Module identification**: All modules now have a `config.yaml` file
---
@@ -114,11 +114,11 @@ In v4, you may have modified agent files directly in `.bmad-*` folders.
### v6 Agent Customization
**All customizations** now go in `bmad/_cfg/agents/` using customize files:
**All customizations** now go in `{bmad_folder}/_cfg/agents/` using customize files:
**Example: Renaming an agent and changing communication style**
File: `bmad/_cfg/agents/bmm-pm.customize.yaml`
File: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
```yaml
# Customize the PM agent
@@ -133,8 +133,8 @@ persona:
**How it works:**
- Base agent: `bmad/bmm/agents/pm.md`
- Customization: `bmad/_cfg/agents/bmm-pm.customize.yaml`
- Base agent: `{bmad_folder}/bmm/agents/pm.md`
- Customization: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
- Result: Agent uses your custom name and style, but updates don't overwrite your changes
---
@@ -212,9 +212,9 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
## Post-Migration Checklist
- [ ] v4 folders backed up to `v4-backup/`
- [ ] v6 installed to `bmad/` folder
- [ ] v6 installed to `{bmad_folder}/` folder
- [ ] `workflow-init` run with correct project level selected
- [ ] Agent customizations migrated to `bmad/_cfg/agents/` if needed
- [ ] Agent customizations migrated to `{bmad_folder}/_cfg/agents/` if needed
- [ ] IDE integration working (test by listing agents)
- [ ] For active development: `sprint-planning` workflow executed
@@ -224,4 +224,4 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
- **Docs**: Check `bmad/docs/` in your installation for IDE-specific instructions
- **Docs**: Check `{bmad_folder}/docs/` in your installation for IDE-specific instructions