mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
* feat(docs): add Diataxis folder structure and update sidebar styling - Create tutorials, how-to, explanation, reference directories with subdirectories - Add index.md files for each main Diataxis section - Update homepage with Diataxis card navigation layout - Implement clean React Native-inspired sidebar styling - Convert sidebar to autogenerated for both Diataxis and legacy sections - Update docusaurus config with dark mode default and navbar changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): migrate Phase 1 files to Diataxis structure Move 21 files to new locations: - Tutorials: quick-start guides, agent creation guide - How-To: installation, customization, workflows - Explanation: core concepts, features, game-dev, builder - Reference: merged glossary from BMM and BMGD Also: - Copy images to new locations - Update internal links via migration script (73 links updated) - Build verified successfully 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(docs): add category labels for sidebar folders Add _category_.json files to control display labels and position for autogenerated sidebar categories. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * style(docs): improve welcome page and visual styling - Rewrite index.md with React Native-inspired welcoming layout - Add Diataxis section cards with descriptions - Remove sidebar separator, add spacing instead - Increase navbar padding with responsive breakpoints - Add rounded admonitions without left border bar - Use system font stack for better readability - Add lighter chevron styling in sidebar - Constrain max-width to 1600px for wide viewports 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use baseUrl in meta tag paths for correct deployment URLs * feat(docs): complete Phase 2 - split files and fix broken links Phase 2 of Diataxis migration: - Split 16 large legacy files into 42+ focused documents - Created FAQ section with 7 topic-specific files - Created brownfield how-to guides (3 files) - Created workflow how-to guides (15+ files) - Created architecture explanation files (3 files) - Created TEA/testing explanation files - Moved remaining legacy module files to proper Diataxis locations Link fixes: - Fixed ~50 broken internal links across documentation - Updated relative paths for new file locations - Created missing index files for installation, advanced tutorials - Simplified TOC anchors to fix Docusaurus warnings Cleanup: - Removed legacy sidebar entries for deleted folders - Deleted duplicate and empty placeholder files - Moved workflow diagram assets to tutorials/images 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(build): use file glob instead of sidebar parsing for llms-full.txt Replace brittle sidebar.js regex parsing with recursive file glob. The old approach captured non-file strings like 'autogenerated' and category labels, resulting in only 5 files being processed. Now correctly processes all 86+ markdown files (~95k tokens). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(seo): use absolute URLs in AI meta tags for agent discoverability AI web-browsing agents couldn't follow relative paths in meta tags due to URL security restrictions. Changed llms-full.txt and llms.txt meta tag URLs from relative (baseUrl) to absolute (urlParts.origin + baseUrl). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): recategorize misplaced files per Diataxis analysis Phase 2.5 categorization fixes based on post-migration analysis: Moved to correct Diataxis categories: - tutorials/installation.md → deleted (duplicate of how-to/install-bmad.md) - tutorials/brownfield-onboarding.md → how-to/brownfield/index.md - reference/faq/* (8 files) → explanation/faq/ - reference/agents/barry-quick-flow.md → explanation/agents/ - reference/agents/bmgd-agents.md → explanation/game-dev/agents.md Created: - explanation/agents/index.md Fixed all broken internal links (14 total) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add Getting Started tutorial and simplify build script - Add comprehensive Getting Started tutorial with installation as Step 1 - Simplify build-docs.js to read directly from docs/ (no consolidation) - Remove backup/restore dance that could corrupt docs folder on build failure - Remove ~150 lines of unused consolidation code 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(css): use fixed width layout to prevent content shifting Apply React Native docs approach: set both width and max-width at largest breakpoint (1400px) so content area maintains consistent size regardless of content length. Switches to fluid 100% below 1416px breakpoint. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): restructure tutorials with renamed entry point - Rename index.md to bmad-tutorial.md for clearer navigation - Remove redundant tutorials/index.md - Update sidebar and config references 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add tutorial style guide and AI agent announcement bar - Add docs/_contributing/ with tutorial style guide - Reformat quick-start-bmm.md and bmad-tutorial.md per style guide - Remove horizontal separators, add strategic admonitions - Add persistent announcement bar for AI agents directing to llms-full.txt - Fix footer broken link to tutorials 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add markdown demo page and UI refinements - Add comprehensive markdown-demo.md for style testing - Remove doc category links from navbar (use sidebar instead) - Remove card buttons from welcome page - Add dark mode styling for announcement bar - Clean up index.md card layout 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): apply unified tutorial style and update references - Reformat create-custom-agent.md to follow tutorial style guide - Update tutorial-style.md with complete unified structure - Update all internal references to renamed tutorial files - Remove obsolete advanced/index.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): migrate from Docusaurus to Astro+Starlight Replace Docusaurus with Astro and the Starlight documentation theme for improved performance, better customization, and modern tooling. Build pipeline changes: - New build-docs.js orchestrates link checking, artifact generation, and Astro build in sequence - Add check-doc-links.js for validating internal links and anchors - Generate llms.txt and llms-full.txt for LLM-friendly documentation - Create downloadable source bundles (bmad-sources.zip, bmad-prompts.zip) - Suppress MODULE_TYPELESS_PACKAGE_JSON warning in Astro build - Output directly to build/site for cleaner deployment Website architecture: - Add rehype-markdown-links.js plugin to transform .md links to routes - Add site-url.js helper for GitHub Pages URL resolution with strict validation (throws on invalid GITHUB_REPOSITORY format) - Custom Astro components: Banner, Header, MobileMenuFooter - Symlink docs/ into website/src/content/docs for Starlight Documentation cleanup: - Remove Docusaurus _category_.json files (Starlight uses frontmatter) - Convert all docs to use YAML frontmatter with title field - Move downloads.md from website/src/pages to docs/ - Consolidate style guide and workflow diagram docs - Add 404.md and tutorials/index.md --------- Co-authored-by: forcetrainer <bryan@inagaki.us> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
209 lines
5.1 KiB
Markdown
209 lines
5.1 KiB
Markdown
---
|
|
title: "Agent Customization Guide"
|
|
---
|
|
|
|
|
|
Customize BMad agents without modifying core files. All customizations persist through updates.
|
|
|
|
## Quick Start
|
|
|
|
**1. Locate Customization Files**
|
|
|
|
After installation, find agent customization files in:
|
|
|
|
```
|
|
_bmad/_config/agents/
|
|
├── core-bmad-master.customize.yaml
|
|
├── bmm-dev.customize.yaml
|
|
├── bmm-pm.customize.yaml
|
|
└── ... (one file per installed agent)
|
|
```
|
|
|
|
**2. Edit Any Agent**
|
|
|
|
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
|
|
|
|
**3. Rebuild the Agent**
|
|
|
|
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
|
|
|
|
```bash
|
|
npx bmad-method@alpha install # and then select option to compile all agents
|
|
npx bmad-method@alpha build <agent-name>
|
|
|
|
npx bmad-method@alpha build bmm-dev
|
|
npx bmad-method@alpha build core-bmad-master
|
|
npx bmad-method@alpha build bmm-pm
|
|
```
|
|
|
|
## What You Can Customize
|
|
|
|
### Agent Name
|
|
|
|
Change how the agent introduces itself:
|
|
|
|
```yaml
|
|
agent:
|
|
metadata:
|
|
name: 'Spongebob' # Default: "Amelia"
|
|
```
|
|
|
|
### Persona
|
|
|
|
Replace the agent's personality, role, and communication style:
|
|
|
|
```yaml
|
|
persona:
|
|
role: 'Senior Full-Stack Engineer'
|
|
identity: 'Lives in a pineapple (under the sea)'
|
|
communication_style: 'Spongebob'
|
|
principles:
|
|
- 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep'
|
|
- 'Favor composition over inheritance'
|
|
```
|
|
|
|
**Note:** The persona section replaces the entire default persona (not merged).
|
|
|
|
### Memories
|
|
|
|
Add persistent context the agent will always remember:
|
|
|
|
```yaml
|
|
memories:
|
|
- 'Works at Krusty Krab'
|
|
- 'Favorite Celebrity: David Hasslehoff'
|
|
- 'Learned in Epic 1 that its not cool to just pretend that tests have passed'
|
|
```
|
|
|
|
### Custom Menu Items
|
|
|
|
Add your own workflows to the agent's menu:
|
|
|
|
```yaml
|
|
menu:
|
|
- trigger: my-workflow
|
|
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
|
description: My custom workflow
|
|
- trigger: deploy
|
|
action: '#deploy-prompt'
|
|
description: Deploy to production
|
|
```
|
|
|
|
**Don't include:** `*` prefix or `help`/`exit` items - these are auto-injected.
|
|
|
|
### Critical Actions
|
|
|
|
Add instructions that execute before the agent starts:
|
|
|
|
```yaml
|
|
critical_actions:
|
|
- 'Always check git status before making changes'
|
|
- 'Use conventional commit messages'
|
|
```
|
|
|
|
### Custom Prompts
|
|
|
|
Define reusable prompts for `action="#id"` menu handlers:
|
|
|
|
```yaml
|
|
prompts:
|
|
- id: deploy-prompt
|
|
content: |
|
|
Deploy the current branch to production:
|
|
1. Run all tests
|
|
2. Build the project
|
|
3. Execute deployment script
|
|
```
|
|
|
|
## Real-World Examples
|
|
|
|
**Example 1: Customize Developer Agent for TDD**
|
|
|
|
```yaml
|
|
agent:
|
|
metadata:
|
|
name: 'TDD Developer'
|
|
|
|
memories:
|
|
- 'Always write tests before implementation'
|
|
- 'Project uses Jest and React Testing Library'
|
|
|
|
critical_actions:
|
|
- 'Review test coverage before committing'
|
|
```
|
|
|
|
**Example 2: Add Custom Deployment Workflow**
|
|
|
|
```yaml
|
|
menu:
|
|
- trigger: deploy-staging
|
|
workflow: '{project-root}/_bmad/deploy-staging.yaml'
|
|
description: Deploy to staging environment
|
|
- trigger: deploy-prod
|
|
workflow: '{project-root}/_bmad/deploy-prod.yaml'
|
|
description: Deploy to production (with approval)
|
|
```
|
|
|
|
**Example 3: Multilingual Product Manager**
|
|
|
|
```yaml
|
|
persona:
|
|
role: 'Bilingual Product Manager'
|
|
identity: 'Expert in US and LATAM markets'
|
|
communication_style: 'Clear, strategic, with cultural awareness'
|
|
principles:
|
|
- 'Consider localization from day one'
|
|
- 'Balance business goals with user needs'
|
|
|
|
memories:
|
|
- 'User speaks English and Spanish'
|
|
- 'Target markets: US and Latin America'
|
|
```
|
|
|
|
## Tips
|
|
|
|
- **Start Small:** Customize one section at a time and rebuild to test
|
|
- **Backup:** Copy customization files before major changes
|
|
- **Update-Safe:** Your customizations in `_config/` survive all BMad updates
|
|
- **Per-Project:** Customization files are per-project, not global
|
|
- **Version Control:** Consider committing `_config/` to share customizations with your team
|
|
|
|
## Module vs. Global Config
|
|
|
|
**Module-Level (Recommended):**
|
|
|
|
- Customize agents per-project in `_bmad/_config/agents/`
|
|
- Different projects can have different agent behaviors
|
|
|
|
**Global Config (Coming Soon):**
|
|
|
|
- Set defaults that apply across all projects
|
|
- Override with project-specific customizations
|
|
|
|
## Troubleshooting
|
|
|
|
**Changes not appearing?**
|
|
|
|
- Make sure you ran `npx bmad-method build <agent-name>` after editing
|
|
- Check YAML syntax is valid (indentation matters!)
|
|
- Verify the agent name matches the file name pattern
|
|
|
|
**Agent not loading?**
|
|
|
|
- Check for YAML syntax errors
|
|
- Ensure required fields aren't left empty if you uncommented them
|
|
- Try reverting to the template and rebuilding
|
|
|
|
**Need to reset?**
|
|
|
|
- Delete the `.customize.yaml` file
|
|
- Run `npx bmad-method build <agent-name>` to regenerate defaults
|
|
|
|
## Next Steps
|
|
|
|
- **[Learn about Agents](../../explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
|
|
- **[Agent Creation Guide](../../tutorials/advanced/create-custom-agent.md)** - Build completely custom agents
|
|
- **[BMM Complete Documentation](../../explanation/bmm/index.md)** - Full BMad Method reference
|
|
|
|
[← Back to Customization](./index.md)
|