docs: reorganize docs structure and archive v4 tutorial
- Remove unused section index files (tutorials, how-to, explanation, reference) - Move getting-started-bmadv4.md to _archive - Update quick-start-bmgd.md to remove archived file reference - Update upgrade-to-v6.md - Update astro.config.mjs for new structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
forcetrainer
parent
db0c3dcab4
commit
10f02daa7b
|
|
@ -1,35 +0,0 @@
|
|||
---
|
||||
title: "Explanation"
|
||||
---
|
||||
|
||||
|
||||
Understanding-oriented content that explains concepts, architecture, and the reasoning behind BMAD's design.
|
||||
|
||||
## Core Concepts
|
||||
|
||||
Foundational concepts you need to understand BMAD.
|
||||
|
||||
- [What are Agents?](./core-concepts/what-are-agents.md)
|
||||
- [What are Workflows?](./core-concepts/what-are-workflows.md)
|
||||
- [What are Modules?](./core-concepts/what-are-modules.md)
|
||||
|
||||
## Architecture
|
||||
|
||||
How BMAD is designed and why.
|
||||
|
||||
## Philosophy
|
||||
|
||||
The thinking behind BMAD's approach.
|
||||
|
||||
## Features
|
||||
|
||||
Deep dives into specific BMAD features.
|
||||
|
||||
- [Party Mode](./features/party-mode.md)
|
||||
- [Brainstorming Techniques](./features/brainstorming-techniques.md)
|
||||
- [Advanced Elicitation](./features/advanced-elicitation.md)
|
||||
- [Web Bundles](./features/web-bundles.md)
|
||||
|
||||
## Modules
|
||||
|
||||
Explanations of BMAD's module ecosystem.
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
title: "How-To Guides"
|
||||
---
|
||||
|
||||
|
||||
Task-oriented guides that show you how to accomplish specific goals. Each guide assumes you already understand the basics.
|
||||
|
||||
## Installation
|
||||
|
||||
- [Upgrade to V6](./installation/upgrade-to-v6.md)
|
||||
- [Install Custom Modules](./installation/install-custom-modules.md)
|
||||
|
||||
## IDE Setup
|
||||
|
||||
*Coming soon*
|
||||
|
||||
## Customization
|
||||
|
||||
- [Customize Agents](./customization/customize-agents.md)
|
||||
- [Customize Workflows](./customization/customize-workflows.md)
|
||||
- [Vendor Workflows](./customization/vendor-workflows.md)
|
||||
- [Shard Large Documents](./customization/shard-large-documents.md)
|
||||
|
||||
## Workflows
|
||||
|
||||
Guides for running specific BMAD workflows.
|
||||
|
||||
## Brownfield Projects
|
||||
|
||||
Working with existing codebases.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Solutions to common problems.
|
||||
|
||||
- [Get Answers About BMAD](./get-answers-about-bmad.md)
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
title: "BMad v4 to v6 Upgrade Guide"
|
||||
title: "Upgrading from Previous Versions"
|
||||
---
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
|
||||
The latest version of BMad represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate from version 4.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,26 +0,0 @@
|
|||
---
|
||||
title: "Reference"
|
||||
---
|
||||
|
||||
|
||||
Information-oriented documentation for looking up facts, specifications, and details.
|
||||
|
||||
## Agents
|
||||
|
||||
Technical reference for all BMAD agents.
|
||||
|
||||
## Workflows
|
||||
|
||||
Technical reference for all BMAD workflows.
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration options and settings.
|
||||
|
||||
## Glossary
|
||||
|
||||
Definitions of BMAD terminology.
|
||||
|
||||
## FAQ
|
||||
|
||||
Frequently asked questions organized by topic.
|
||||
|
|
@ -7,7 +7,7 @@ description: Build games with BMad's Game Development Module
|
|||
Build games faster using AI-powered workflows with specialized game development agents that guide you through preproduction, design, architecture, and implementation.
|
||||
|
||||
:::note[Module Extension]
|
||||
BMGD (BMad Game Development) is a module that extends BMad Method. You'll need BMad installed first—see the [BMad v4 tutorial](./getting-started-bmadv4.md) or [BMad v6 tutorial](./getting-started-bmadv6.md) if you haven't installed it yet.
|
||||
BMGD (BMad Game Development) is a module that extends BMad Method. You'll need BMad installed first—see the [BMad v6 tutorial](./getting-started-bmadv6.md) if you haven't installed it yet.
|
||||
:::
|
||||
|
||||
## What You'll Learn
|
||||
|
|
@ -36,12 +36,12 @@ BMGD (BMad Game Development) is a module that extends BMad Method. You'll need B
|
|||
|
||||
BMGD follows four game development phases with specialized agents for each:
|
||||
|
||||
| Phase | Name | What Happens |
|
||||
|-------|------|--------------|
|
||||
| 1 | Preproduction | Capture game vision, create Game Brief *(optional brainstorming)* |
|
||||
| 2 | Design | Detail mechanics, systems, narrative in GDD |
|
||||
| 3 | Technical | Plan engine, architecture, technical decisions |
|
||||
| 4 | Production | Build game in sprints, story by story |
|
||||
| Phase | Name | What Happens |
|
||||
| ----- | ------------- | ----------------------------------------------------------------- |
|
||||
| 1 | Preproduction | Capture game vision, create Game Brief *(optional brainstorming)* |
|
||||
| 2 | Design | Detail mechanics, systems, narrative in GDD |
|
||||
| 3 | Technical | Plan engine, architecture, technical decisions |
|
||||
| 4 | Production | Build game in sprints, story by story |
|
||||
|
||||
|
||||
|
||||
|
|
@ -49,14 +49,14 @@ BMGD follows four game development phases with specialized agents for each:
|
|||
|
||||
### Game Development Agents
|
||||
|
||||
| Agent | When to Use |
|
||||
|-------|-------------|
|
||||
| **Game Designer** | Brainstorming, Game Brief, GDD, Narrative |
|
||||
| **Game Architect** | Architecture, technical decisions |
|
||||
| **Game Developer** | Implementation, code reviews |
|
||||
| **Game Scrum Master** | Sprint planning, story management |
|
||||
| **Game QA** | Test framework, test design, automation |
|
||||
| **Game Solo Dev** | Quick prototyping, indie development |
|
||||
| Agent | When to Use |
|
||||
| --------------------- | ----------------------------------------- |
|
||||
| **Game Designer** | Brainstorming, Game Brief, GDD, Narrative |
|
||||
| **Game Architect** | Architecture, technical decisions |
|
||||
| **Game Developer** | Implementation, code reviews |
|
||||
| **Game Scrum Master** | Sprint planning, story management |
|
||||
| **Game QA** | Test framework, test design, automation |
|
||||
| **Game Solo Dev** | Quick prototyping, indie development |
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -171,12 +171,12 @@ Load the **Game Scrum Master** agent and run `sprint-planning`. This creates `sp
|
|||
|
||||
For each story, repeat this cycle with fresh chats:
|
||||
|
||||
| Step | Agent | Workflow | Purpose |
|
||||
|------|-------|----------|---------|
|
||||
| 1 | Game SM | `create-story` | Create story file from epic |
|
||||
| 2 | Game Dev | `dev-story` | Implement the story |
|
||||
| 3 | Game QA | `automate` | Generate tests *(optional)* |
|
||||
| 4 | Game Dev | `code-review` | Quality validation *(recommended)* |
|
||||
| Step | Agent | Workflow | Purpose |
|
||||
| ---- | -------- | -------------- | ---------------------------------- |
|
||||
| 1 | Game SM | `create-story` | Create story file from epic |
|
||||
| 2 | Game Dev | `dev-story` | Implement the story |
|
||||
| 3 | Game QA | `automate` | Generate tests *(optional)* |
|
||||
| 4 | Game Dev | `code-review` | Quality validation *(recommended)* |
|
||||
|
||||
After completing all stories in an epic, load the **Game SM** and run `retrospective`.
|
||||
|
||||
|
|
@ -213,18 +213,18 @@ your-project/
|
|||
|
||||
## Quick Reference
|
||||
|
||||
| Command | Agent | Purpose |
|
||||
|---------|-------|---------|
|
||||
| `*brainstorm-game` | Game Designer | Guided game ideation |
|
||||
| `*create-game-brief` | Game Designer | Create Game Brief |
|
||||
| `*create-gdd` | Game Designer | Create Game Design Document |
|
||||
| `*narrative` | Game Designer | Create Narrative Design |
|
||||
| `*create-architecture` | Game Architect | Create game architecture |
|
||||
| `*sprint-planning` | Game SM | Initialize sprint tracking |
|
||||
| `*create-story` | Game SM | Create a story file |
|
||||
| `*dev-story` | Game Dev | Implement a story |
|
||||
| `*code-review` | Game Dev | Review implemented code |
|
||||
| `*workflow-status` | Any | Check progress and next steps |
|
||||
| Command | Agent | Purpose |
|
||||
| ---------------------- | -------------- | ----------------------------- |
|
||||
| `*brainstorm-game` | Game Designer | Guided game ideation |
|
||||
| `*create-game-brief` | Game Designer | Create Game Brief |
|
||||
| `*create-gdd` | Game Designer | Create Game Design Document |
|
||||
| `*narrative` | Game Designer | Create Narrative Design |
|
||||
| `*create-architecture` | Game Architect | Create game architecture |
|
||||
| `*sprint-planning` | Game SM | Initialize sprint tracking |
|
||||
| `*create-story` | Game SM | Create a story file |
|
||||
| `*dev-story` | Game Dev | Implement a story |
|
||||
| `*code-review` | Game Dev | Review implemented code |
|
||||
| `*workflow-status` | Any | Check progress and next steps |
|
||||
|
||||
## Common Questions
|
||||
|
||||
|
|
|
|||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
title: "Tutorials"
|
||||
---
|
||||
|
||||
|
||||
Learning-oriented guides that walk you through building something real with BMad. Perfect for getting hands-on experience.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Start your journey with BMad by choosing a version that fits your needs:
|
||||
|
||||
- [Get Started with v4 (Stable)](./getting-started/getting-started-bmadv4.md) — Production-ready version with battle-tested workflows
|
||||
- [Try v6 (Alpha)](./getting-started/getting-started-bmadv6.md) — Latest features, still in active development
|
||||
|
||||
## First Project
|
||||
|
||||
Your first end-to-end project with BMad.
|
||||
|
||||
## Advanced
|
||||
|
||||
More complex scenarios and advanced patterns.
|
||||
|
|
@ -87,22 +87,115 @@ export default defineConfig({
|
|||
{
|
||||
label: 'Tutorials',
|
||||
collapsed: false,
|
||||
autogenerate: { directory: 'tutorials' },
|
||||
items: [
|
||||
{
|
||||
label: 'Getting Started',
|
||||
autogenerate: { directory: 'tutorials/getting-started' },
|
||||
},
|
||||
{
|
||||
label: 'Advanced',
|
||||
autogenerate: { directory: 'tutorials/advanced' },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'How-To Guides',
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'how-to' },
|
||||
items: [
|
||||
{ slug: 'how-to/get-answers-about-bmad' },
|
||||
{
|
||||
label: 'Installation',
|
||||
autogenerate: { directory: 'how-to/installation' },
|
||||
},
|
||||
{
|
||||
label: 'Workflows',
|
||||
autogenerate: { directory: 'how-to/workflows' },
|
||||
},
|
||||
{
|
||||
label: 'Customization',
|
||||
autogenerate: { directory: 'how-to/customization' },
|
||||
},
|
||||
{
|
||||
label: 'Brownfield Development',
|
||||
autogenerate: { directory: 'how-to/brownfield' },
|
||||
},
|
||||
{
|
||||
label: 'Troubleshooting',
|
||||
autogenerate: { directory: 'how-to/troubleshooting' },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Explanation',
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'explanation' },
|
||||
items: [
|
||||
{
|
||||
label: 'Core Concepts',
|
||||
autogenerate: { directory: 'explanation/core-concepts' },
|
||||
},
|
||||
{
|
||||
label: 'Architecture',
|
||||
autogenerate: { directory: 'explanation/architecture' },
|
||||
},
|
||||
{
|
||||
label: 'Philosophy',
|
||||
autogenerate: { directory: 'explanation/philosophy' },
|
||||
},
|
||||
{
|
||||
label: 'Features',
|
||||
autogenerate: { directory: 'explanation/features' },
|
||||
},
|
||||
{
|
||||
label: 'Agents',
|
||||
autogenerate: { directory: 'explanation/agents' },
|
||||
},
|
||||
{
|
||||
label: 'BMM',
|
||||
autogenerate: { directory: 'explanation/bmm' },
|
||||
},
|
||||
{
|
||||
label: 'BMad Builder',
|
||||
autogenerate: { directory: 'explanation/bmad-builder' },
|
||||
},
|
||||
{
|
||||
label: 'Game Development',
|
||||
autogenerate: { directory: 'explanation/game-dev' },
|
||||
},
|
||||
{
|
||||
label: 'Creative Intelligence',
|
||||
autogenerate: { directory: 'explanation/creative-intelligence' },
|
||||
},
|
||||
{
|
||||
label: 'Core Module',
|
||||
autogenerate: { directory: 'explanation/core' },
|
||||
},
|
||||
{
|
||||
label: 'FAQ',
|
||||
autogenerate: { directory: 'explanation/faq' },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Reference',
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'reference' },
|
||||
items: [
|
||||
{
|
||||
label: 'Agents',
|
||||
autogenerate: { directory: 'reference/agents' },
|
||||
},
|
||||
{
|
||||
label: 'Workflows',
|
||||
autogenerate: { directory: 'reference/workflows' },
|
||||
},
|
||||
{
|
||||
label: 'Configuration',
|
||||
autogenerate: { directory: 'reference/configuration' },
|
||||
},
|
||||
{
|
||||
label: 'Glossary',
|
||||
autogenerate: { directory: 'reference/glossary' },
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue