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>
139 lines
3.3 KiB
Markdown
139 lines
3.3 KiB
Markdown
---
|
|
title: "Preventing Agent Conflicts"
|
|
description: How architecture prevents conflicts when multiple agents implement a system
|
|
---
|
|
|
|
|
|
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
|
|
|
---
|
|
|
|
## Common Conflict Types
|
|
|
|
### API Style Conflicts
|
|
|
|
Without architecture:
|
|
- Agent A uses REST with `/users/{id}`
|
|
- Agent B uses GraphQL mutations
|
|
- Result: Inconsistent API patterns, confused consumers
|
|
|
|
With architecture:
|
|
- ADR specifies: "Use GraphQL for all client-server communication"
|
|
- All agents follow the same pattern
|
|
|
|
### Database Design Conflicts
|
|
|
|
Without architecture:
|
|
- Agent A uses snake_case column names
|
|
- Agent B uses camelCase column names
|
|
- Result: Inconsistent schema, confusing queries
|
|
|
|
With architecture:
|
|
- Standards document specifies naming conventions
|
|
- All agents follow the same patterns
|
|
|
|
### State Management Conflicts
|
|
|
|
Without architecture:
|
|
- Agent A uses Redux for global state
|
|
- Agent B uses React Context
|
|
- Result: Multiple state management approaches, complexity
|
|
|
|
With architecture:
|
|
- ADR specifies state management approach
|
|
- All agents implement consistently
|
|
|
|
---
|
|
|
|
## How Architecture Prevents Conflicts
|
|
|
|
### 1. Explicit Decisions via ADRs
|
|
|
|
Every significant technology choice is documented with:
|
|
- Context (why this decision matters)
|
|
- Options considered (what alternatives exist)
|
|
- Decision (what we chose)
|
|
- Rationale (why we chose it)
|
|
- Consequences (trade-offs accepted)
|
|
|
|
### 2. FR/NFR-Specific Guidance
|
|
|
|
Architecture maps each functional requirement to technical approach:
|
|
- FR-001: User Management → GraphQL mutations
|
|
- FR-002: Mobile App → Optimized queries
|
|
|
|
### 3. Standards and Conventions
|
|
|
|
Explicit documentation of:
|
|
- Directory structure
|
|
- Naming conventions
|
|
- Code organization
|
|
- Testing patterns
|
|
|
|
---
|
|
|
|
## Architecture as Shared Context
|
|
|
|
Think of architecture as the shared context that all agents read before implementing:
|
|
|
|
```
|
|
PRD: "What to build"
|
|
↓
|
|
Architecture: "How to build it"
|
|
↓
|
|
Agent A reads architecture → implements Epic 1
|
|
Agent B reads architecture → implements Epic 2
|
|
Agent C reads architecture → implements Epic 3
|
|
↓
|
|
Result: Consistent implementation
|
|
```
|
|
|
|
---
|
|
|
|
## Key ADR Topics
|
|
|
|
Common decisions that prevent conflicts:
|
|
|
|
| Topic | Example Decision |
|
|
|-------|-----------------|
|
|
| API Style | GraphQL vs REST vs gRPC |
|
|
| Database | PostgreSQL vs MongoDB |
|
|
| Auth | JWT vs Sessions |
|
|
| State Management | Redux vs Context vs Zustand |
|
|
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
|
| Testing | Jest + Playwright vs Vitest + Cypress |
|
|
|
|
---
|
|
|
|
## Anti-Patterns
|
|
|
|
### ❌ Implicit Decisions
|
|
|
|
"We'll figure out the API style as we go"
|
|
→ Leads to inconsistency
|
|
|
|
### ❌ Over-Documentation
|
|
|
|
Every minor choice documented
|
|
→ Analysis paralysis, wasted time
|
|
|
|
### ❌ Stale Architecture
|
|
|
|
Document written once, never updated
|
|
→ Agents follow outdated patterns
|
|
|
|
### ✅ Correct Approach
|
|
|
|
- Document decisions that cross epic boundaries
|
|
- Focus on conflict-prone areas
|
|
- Update architecture as you learn
|
|
- Use `correct-course` for significant changes
|
|
|
|
---
|
|
|
|
## Related
|
|
|
|
- [Why Solutioning Matters](./why-solutioning-matters.md)
|
|
- [Four Phases](./four-phases.md)
|
|
- [Create Architecture](../../how-to/workflows/create-architecture.md)
|