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>
This commit is contained in:
forcetrainer
Alex Verkhovsky
parent
d988c34b65
commit
5d1f820f82
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
sidebar_label: Agents
|
||||
description: Understanding BMAD agents and their roles
|
||||
---
|
||||
|
||||
# Understanding Agents
|
||||
|
||||
Comprehensive guides to BMAD's AI agents - their roles, capabilities, and how to work with them effectively.
|
||||
|
||||
---
|
||||
|
||||
## Agent Guides
|
||||
|
||||
### BMM Agents
|
||||
|
||||
- **[Agent Roles](../core-concepts/agent-roles.md)** - Overview of all BMM agent roles and responsibilities
|
||||
- **[Quick Flow Solo Dev (Barry)](./barry-quick-flow.md)** - The dedicated agent for rapid development
|
||||
|
||||
### BMGD Agents
|
||||
|
||||
- **[Game Development Agents](../game-dev/agents.md)** - Complete guide to BMGD's specialized game dev agents
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- **[What Are Agents?](../core-concepts/what-are-agents.md)** - Core concept explanation
|
||||
- **[Party Mode](../features/party-mode.md)** - Multi-agent collaboration
|
||||
- **[Customize Agents](../../how-to/customization/customize-agents.md)** - How to customize agent behavior
|
||||
|
|
@ -38,7 +38,7 @@ First know there is the full BMad Method Process and then there is a Quick Flow
|
|||
- Perfect for bug fixes and small features
|
||||
- Rapid prototyping with production quality
|
||||
- Implementation in minutes, not days
|
||||
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](../../reference/agents/barry-quick-flow.md)**
|
||||
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](../agents/barry-quick-flow.md)**
|
||||
|
||||
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](../../explanation/features/tea-overview.md)**.
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ Complete guide to BMM's AI agent team:
|
|||
|
||||
Comprehensive guide for brownfield development:
|
||||
|
||||
- **[Brownfield Development Guide](../../tutorials/advanced/brownfield-onboarding.md)** - Complete guide for existing codebases
|
||||
- **[Brownfield Development Guide](../../how-to/brownfield/index.md)** - Complete guide for existing codebases
|
||||
- Documentation phase strategies
|
||||
- Track selection for brownfield
|
||||
- Integration with existing patterns
|
||||
|
|
@ -76,7 +76,7 @@ Comprehensive guide for brownfield development:
|
|||
Essential reference materials:
|
||||
|
||||
- **[Glossary](../../reference/glossary/index.md)** - Key terminology and concepts
|
||||
- **[FAQ](../../reference/faq/index.md)** - Frequently asked questions across all topics
|
||||
- **[FAQ](../faq/index.md)** - Frequently asked questions across all topics
|
||||
|
||||
## 🎯 Choose Your Path
|
||||
|
||||
|
|
@ -86,10 +86,10 @@ Essential reference materials:
|
|||
→ Start with [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md)
|
||||
|
||||
**Fix a bug or add small feature**
|
||||
→ User the [Quick Flow Solo Dev](../../reference/agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](../../explanation/features/quick-flow.md) process
|
||||
→ Use the [Quick Flow Solo Dev](../agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](../features/quick-flow.md) process
|
||||
|
||||
**Work with existing codebase (brownfield)**
|
||||
→ Read [Brownfield Development Guide](../../tutorials/advanced/brownfield-onboarding.md)
|
||||
→ Read [Brownfield Development Guide](../../how-to/brownfield/index.md)
|
||||
→ Pay special attention to documentation requirements for brownfield projects
|
||||
|
||||
## 📋 Workflow Guides
|
||||
|
|
|
|||
|
|
@ -73,8 +73,8 @@ BMM respects your choice - it won't force modernization, but it will offer it.
|
|||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Get started with BMM
|
||||
- [Brownfield Guide](../../tutorials/advanced/brownfield-onboarding.md) - Existing codebase workflows
|
||||
- [Glossary](../glossary/index.md) - Terminology reference
|
||||
- [Brownfield Guide](../../how-to/brownfield/index.md) - Existing codebase workflows
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ Quick workflows like status checks can reuse chats safely.
|
|||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Get started with BMM
|
||||
- [Glossary](../glossary/index.md) - Terminology reference
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -50,7 +50,7 @@ Don't wait until project end - run after each epic for continuous improvement.
|
|||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Get started with BMM
|
||||
- [Glossary](../glossary/index.md) - Terminology reference
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -52,7 +52,7 @@ The overlap (5-10 stories) is intentional. Choose based on:
|
|||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Get started with BMM
|
||||
- [Glossary](../glossary/index.md) - Terminology reference
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ PRDs are for Level 2-4 projects with multiple features requiring product-level c
|
|||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Get started with BMM
|
||||
- [Glossary](../glossary/index.md) - Terminology reference
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -242,7 +242,7 @@ Please include:
|
|||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Get started with BMM
|
||||
- [Glossary](../glossary/index.md) - Terminology reference
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ If status file exists, use workflow-status. If not, use workflow-init.
|
|||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Get started with BMM
|
||||
- [Glossary](../glossary/index.md) - Terminology reference
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -87,6 +87,6 @@ Follow the standard Phase 4 implementation workflows:
|
|||
|
||||
## Related
|
||||
|
||||
- [Brownfield Onboarding Tutorial](../../tutorials/advanced/brownfield-onboarding.md)
|
||||
- [Brownfield Development Guide](./index.md)
|
||||
- [Document Existing Project](./document-existing-project.md)
|
||||
- [Quick Fix in Brownfield](./quick-fix-in-brownfield.md)
|
||||
|
|
|
|||
|
|
@ -81,5 +81,5 @@ Review the documentation for:
|
|||
|
||||
## Related
|
||||
|
||||
- [Brownfield Onboarding Tutorial](../../tutorials/advanced/brownfield-onboarding.md)
|
||||
- [Brownfield Development Guide](./index.md)
|
||||
- [Add Feature to Existing Project](./add-feature-to-existing.md)
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
sidebar_label: Brownfield Onboarding
|
||||
description: Learn how to use BMad Method on existing codebases
|
||||
sidebar_label: Brownfield Development
|
||||
description: How to use BMad Method on existing codebases
|
||||
---
|
||||
|
||||
# Brownfield Development Tutorial
|
||||
# Brownfield Development
|
||||
|
||||
Learn how to effectively use BMad Method when working on existing projects and legacy codebases.
|
||||
How to effectively use BMad Method when working on existing projects and legacy codebases.
|
||||
|
||||
## What is Brownfield Development?
|
||||
|
||||
|
|
@ -93,11 +93,11 @@ Pay close attention here to prevent reinventing the wheel or making decisions th
|
|||
- **[Document Existing Project](../../how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
|
||||
- **[Add Feature to Existing Project](../../how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality
|
||||
- **[Quick Fix in Brownfield](../../how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
||||
- **[Brownfield FAQ](../../reference/faq/brownfield-faq.md)** - Common questions about brownfield development
|
||||
- **[Brownfield FAQ](../../explanation/faq/brownfield-faq.md)** - Common questions about brownfield development
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../getting-started/quick-start-bmm.md) - Getting started with BMM
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Getting started with BMM
|
||||
- [Quick Spec Flow](../../explanation/features/quick-flow.md) - Fast path for small changes
|
||||
|
|
@ -90,6 +90,6 @@ Consider using Quick Flow or full BMad Method when:
|
|||
|
||||
## Related
|
||||
|
||||
- [Brownfield Onboarding Tutorial](../../tutorials/advanced/brownfield-onboarding.md)
|
||||
- [Brownfield Development Guide](./index.md)
|
||||
- [Add Feature to Existing Project](./add-feature-to-existing.md)
|
||||
- [Quick Spec Flow](../../explanation/features/quick-flow.md)
|
||||
|
|
|
|||
|
|
@ -136,6 +136,6 @@ npx bmad-method install --verbose
|
|||
|
||||
## Related
|
||||
|
||||
- [Installation Tutorial](../../tutorials/getting-started/installation.md) - Getting started
|
||||
- [Quick Start Guide](../../tutorials/getting-started/quick-start-bmm.md) - Getting started with BMM
|
||||
- [Upgrade to V6](./upgrade-to-v6.md) - Upgrading from previous versions
|
||||
- [Install Custom Modules](./install-custom-modules.md) - Adding custom content
|
||||
|
|
|
|||
|
|
@ -284,5 +284,5 @@ If quick-dev keeps expanding scope, stop and create proper stories.
|
|||
## Next Steps
|
||||
|
||||
- **[Workflows Guide](../../reference/workflows/bmgd-workflows.md)** - Full workflow reference
|
||||
- **[Agents Guide](../../reference/agents/bmgd-agents.md)** - Agent capabilities
|
||||
- **[Agents Guide](../../explanation/game-dev/agents.md)** - Agent capabilities
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Getting started with BMGD
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ The fastest way to understand BMAD is to try it. The Quick Start guide walks you
|
|||
<br/>
|
||||
|
||||
:::tip Already familiar with AI-assisted development?
|
||||
Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](/docs/explanation/core-concepts/what-are-agents) to understand how BMAD organizes its AI personas.
|
||||
Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](./explanation/core-concepts/what-are-agents.md) to understand how BMAD organizes its AI personas.
|
||||
:::
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
{ "label": "FAQ", "position": 5 }
|
||||
|
|
@ -459,5 +459,5 @@ This means:
|
|||
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
||||
- **[Quick-Flow Guide](../../how-to/workflows/bmgd-quick-flow.md)** - Rapid prototyping and development
|
||||
- **[Agents Guide](../agents/bmgd-agents.md)** - Agent reference
|
||||
- **[Agents Guide](../../explanation/game-dev/agents.md)** - Agent reference
|
||||
- **[Game Types Guide](../../explanation/game-dev/game-types.md)** - Game type templates
|
||||
|
|
|
|||
|
|
@ -67,5 +67,5 @@ The workflow can be interrupted and resumed without losing progress:
|
|||
|
||||
**Related Documentation:**
|
||||
|
||||
- [Brownfield Development Guide](../../tutorials/advanced/brownfield-onboarding.md)
|
||||
- [Brownfield Development Guide](../../how-to/brownfield/index.md)
|
||||
- [Implementation Workflows](../../how-to/workflows/run-sprint-planning.md)
|
||||
|
|
|
|||
|
|
@ -11,5 +11,6 @@ Deep-dive tutorials for advanced BMad Method usage.
|
|||
|
||||
| Tutorial | Description |
|
||||
|----------|-------------|
|
||||
| **[Brownfield Onboarding](./brownfield-onboarding.md)** | Integrate BMad into existing projects |
|
||||
| **[Create Custom Agent](./create-custom-agent.md)** | Build your own AI agents |
|
||||
|
||||
> **Looking for Brownfield Development?** See the [Brownfield Development Guide](../../how-to/brownfield/index.md) in How-To guides.
|
||||
|
|
|
|||
|
|
@ -1,101 +0,0 @@
|
|||
---
|
||||
sidebar_label: Installation
|
||||
description: Getting started with BMAD installation
|
||||
---
|
||||
|
||||
# Installation Tutorial
|
||||
|
||||
Get BMAD up and running in your project with this step-by-step guide.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, ensure you have:
|
||||
|
||||
- **Node.js** 20+ (for the installer)
|
||||
- **Git** (recommended for version control)
|
||||
- An **AI-powered IDE** or access to Claude/ChatGPT/Gemini
|
||||
|
||||
---
|
||||
|
||||
## Quick Install
|
||||
|
||||
Run the interactive installer:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
This will guide you through the installation process interactively.
|
||||
|
||||
---
|
||||
|
||||
## What the Installer Does
|
||||
|
||||
The interactive installer will:
|
||||
|
||||
1. **Choose location** - Where to install BMAD files
|
||||
2. **Select AI tools** - Claude Code, Cursor, Windsurf, etc.
|
||||
3. **Choose modules** - BMad Method, Creative Intelligence, BMad Builder
|
||||
4. **Add custom content** - Your own agents, workflows, or modules
|
||||
5. **Configure settings** - Accept defaults or customize each module
|
||||
|
||||
---
|
||||
|
||||
## Module Options
|
||||
|
||||
During installation, choose which modules to install:
|
||||
|
||||
| Module | Description | Best For |
|
||||
| -------- | -------------------- | ----------------------------------------------------- |
|
||||
| **BMM** | BMAD Method Core | Software development projects |
|
||||
| **BMGD** | Game Development | Game projects with specialized workflows |
|
||||
| **CIS** | Creative Intel Suite | Creativity unlocking, not software dev specific |
|
||||
| **BMB** | Builder | Creating custom agents and workflows |
|
||||
|
||||
---
|
||||
|
||||
## Post-Installation Structure
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/ # BMAD configuration and agents
|
||||
│ ├── bmm/ # Method module (if installed)
|
||||
│ ├── bmgd/ # Game dev module (if installed)
|
||||
│ ├── core/ # Core utilities (always installed)
|
||||
│ └── {others}/ # Additional modules
|
||||
├── _bmad-output/ # Default output folder
|
||||
├── .claude/ # IDE-specific setup (varies)
|
||||
└── ... your code
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Upgrading?
|
||||
|
||||
If you're upgrading from a previous version, see the [Upgrade Guide](../../how-to/installation/upgrade-to-v6.md).
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After installation:
|
||||
|
||||
1. **[Quick Start Guide](./quick-start-bmm.md)** - Build your first feature
|
||||
2. **[Understanding Workflows](../../explanation/core-concepts/what-are-workflows.md)** - Learn the methodology
|
||||
3. **[Understanding Agents](../../explanation/core-concepts/what-are-agents.md)** - BMAD's core building blocks
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"Command not found: npx"**
|
||||
Install Node.js 20+ from [nodejs.org](https://nodejs.org)
|
||||
|
||||
**"Permission denied"**
|
||||
Run with appropriate permissions or check your npm configuration
|
||||
|
||||
For more help, see [Install BMAD](../../how-to/installation/install-bmad.md) or join our [Discord](https://discord.gg/bmad).
|
||||
|
|
@ -239,7 +239,7 @@ Use `party-mode` to get perspectives from multiple agents when facing complex de
|
|||
|
||||
## Next Steps
|
||||
|
||||
- **[Agents Guide](../../reference/agents/bmgd-agents.md)** - Learn about each agent's capabilities
|
||||
- **[Agents Guide](../../explanation/game-dev/agents.md)** - Learn about each agent's capabilities
|
||||
- **[Workflows Guide](../../reference/workflows/bmgd-workflows.md)** - Detailed workflow reference
|
||||
- **[Quick-Flow Guide](../../how-to/workflows/bmgd-quick-flow.md)** - Rapid prototyping and development
|
||||
- **[Game Types Guide](../../explanation/game-dev/game-types.md)** - Understand game type templates
|
||||
|
|
|
|||
Loading…
Reference in New Issue