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>
This commit is contained in:
parent
6cea197928
commit
5eaa555739
|
|
@ -1,9 +1,10 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Getting Started
|
sidebar_label: BMad v4
|
||||||
|
sidebar_position: 1
|
||||||
description: Install BMAD and create your first planning document
|
description: Install BMAD and create your first planning document
|
||||||
---
|
---
|
||||||
|
|
||||||
# Getting Started with BMAD
|
# Getting Started with BMad v4
|
||||||
|
|
||||||
Learn how to build software with BMAD's AI-powered workflows. By the end of this tutorial, you'll have installed BMAD, initialized a project, and created your first planning document.
|
Learn how to build software with BMAD's AI-powered workflows. By the end of this tutorial, you'll have installed BMAD, initialized a project, and created your first planning document.
|
||||||
|
|
||||||
|
|
@ -126,10 +127,10 @@ Workflows are guided processes that agents run. You tell an agent to run a workf
|
||||||
|
|
||||||
Based on your project's complexity, BMAD offers three tracks:
|
Based on your project's complexity, BMAD offers three tracks:
|
||||||
|
|
||||||
| Track | Best For | Documents Created |
|
| Track | Best For | Documents Created |
|
||||||
| --------------- | ------------------------------------------ | ------------------------------ |
|
| --------------- | ------------------------------------------ | -------------------------------------- |
|
||||||
| **Quick Flow** | Bug fixes, simple features, clear scope | Tech-spec only |
|
| **Quick Flow** | Bug fixes, simple features, clear scope | Tech-spec only |
|
||||||
| **BMAD Method** | Products, platforms, complex features | PRD + Architecture + UX |
|
| **BMAD Method** | Products, platforms, complex features | PRD + Architecture + UX |
|
||||||
| **Enterprise** | Compliance, multi-tenant, enterprise needs | PRD + Architecture + Security + DevOps |
|
| **Enterprise** | Compliance, multi-tenant, enterprise needs | PRD + Architecture + Security + DevOps |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -305,11 +306,11 @@ Explore related topics:
|
||||||
|
|
||||||
Commands you learned in this tutorial:
|
Commands you learned in this tutorial:
|
||||||
|
|
||||||
| Command | Agent | Purpose |
|
| Command | Agent | Purpose |
|
||||||
| ---------------- | ------- | ---------------------------------- |
|
| ----------------- | ------- | -------------------------------------- |
|
||||||
| `*workflow-init` | Analyst | Initialize a new project |
|
| `*workflow-init` | Analyst | Initialize a new project |
|
||||||
| `*prd` | PM | Create a Product Requirements Document |
|
| `*prd` | PM | Create a Product Requirements Document |
|
||||||
| `workflow-status`| Any | Check progress and next steps |
|
| `workflow-status` | Any | Check progress and next steps |
|
||||||
|
|
||||||
> **Tip**: Agents are flexible with commands. Menu numbers, shortcuts (`*prd`), or natural language ("Let's create a PRD") all work.
|
> **Tip**: Agents are flexible with commands. Menu numbers, shortcuts (`*prd`), or natural language ("Let's create a PRD") all work.
|
||||||
|
|
||||||
|
|
@ -1,4 +1,9 @@
|
||||||
# BMGD Quick Start Guide
|
---
|
||||||
|
sidebar_label: Game Dev Module
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Getting started with the BMad Game Developer Module
|
||||||
|
|
||||||
Get started building games with the BMad Game Development Module.
|
Get started building games with the BMad Game Development Module.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,13 @@
|
||||||
# BMad Method V6 Quick Start Guide
|
---
|
||||||
|
sidebar_label: BMad v6 (Alpha)
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Getting Started with BMad v6 Alpha
|
||||||
|
|
||||||
|
:::warning[Alpha Software]
|
||||||
|
BMad v6 is currently in **alpha**. Expect breaking changes, incomplete features, and evolving documentation. If you prefer a stable experience, use the [BMad v4 tutorial](./bmad-tutorial.md) instead.
|
||||||
|
:::
|
||||||
|
|
||||||
Get started with BMad Method v6 for your new greenfield project. This guide walks you through building software from scratch using AI-powered workflows.
|
Get started with BMad Method v6 for your new greenfield project. This guide walks you through building software from scratch using AI-powered workflows.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
# Tutorials
|
|
||||||
|
|
||||||
Learning-oriented guides that take you through a series of steps to complete a project. Start here if you're new to BMAD.
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
- [Quick Start - BMad Method](./getting-started/quick-start-bmm.md) - Get up and running with BMad Method
|
|
||||||
- [Quick Start - Game Dev](./getting-started/quick-start-bmgd.md) - Get started with BMGD for game development
|
|
||||||
|
|
||||||
## Your First Project
|
|
||||||
|
|
||||||
Step-by-step tutorials for building your first project with BMAD.
|
|
||||||
|
|
||||||
*Coming soon*
|
|
||||||
|
|
||||||
## Advanced Tutorials
|
|
||||||
|
|
||||||
Deep-dive tutorials for experienced users.
|
|
||||||
|
|
||||||
- [Create a Custom Agent](./advanced/create-custom-agent.md) - Build your own specialized agent
|
|
||||||
|
|
@ -116,7 +116,7 @@ const config = {
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
type: 'doc',
|
type: 'doc',
|
||||||
docId: 'tutorials/index',
|
docId: 'tutorials/getting-started/bmad-tutorial',
|
||||||
position: 'left',
|
position: 'left',
|
||||||
label: 'Tutorials',
|
label: 'Tutorials',
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,6 @@ const sidebars = {
|
||||||
type: 'category',
|
type: 'category',
|
||||||
label: 'Tutorials',
|
label: 'Tutorials',
|
||||||
collapsed: false,
|
collapsed: false,
|
||||||
link: { type: 'doc', id: 'tutorials/index' },
|
|
||||||
items: [{ type: 'autogenerated', dirName: 'tutorials' }],
|
items: [{ type: 'autogenerated', dirName: 'tutorials' }],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue