From 5eaa5557397eb6910d422466f381d863ac817eee Mon Sep 17 00:00:00 2001 From: forcetrainer Date: Sat, 3 Jan 2026 19:10:12 -0500 Subject: [PATCH] refactor(docs): restructure tutorials with renamed entry point MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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 --- .../{index.md => bmad-tutorial.md} | 23 ++++++++++--------- .../getting-started/quick-start-bmgd.md | 7 +++++- .../getting-started/quick-start-bmm.md | 11 ++++++++- docs/tutorials/index.md | 20 ---------------- website/docusaurus.config.js | 2 +- website/sidebars.js | 1 - 6 files changed, 29 insertions(+), 35 deletions(-) rename docs/tutorials/getting-started/{index.md => bmad-tutorial.md} (94%) delete mode 100644 docs/tutorials/index.md diff --git a/docs/tutorials/getting-started/index.md b/docs/tutorials/getting-started/bmad-tutorial.md similarity index 94% rename from docs/tutorials/getting-started/index.md rename to docs/tutorials/getting-started/bmad-tutorial.md index c8d850be..3e62691e 100644 --- a/docs/tutorials/getting-started/index.md +++ b/docs/tutorials/getting-started/bmad-tutorial.md @@ -1,9 +1,10 @@ --- -sidebar_label: Getting Started +sidebar_label: BMad v4 +sidebar_position: 1 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. @@ -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: -| Track | Best For | Documents Created | -| --------------- | ------------------------------------------ | ------------------------------ | -| **Quick Flow** | Bug fixes, simple features, clear scope | Tech-spec only | -| **BMAD Method** | Products, platforms, complex features | PRD + Architecture + UX | +| Track | Best For | Documents Created | +| --------------- | ------------------------------------------ | -------------------------------------- | +| **Quick Flow** | Bug fixes, simple features, clear scope | Tech-spec only | +| **BMAD Method** | Products, platforms, complex features | PRD + Architecture + UX | | **Enterprise** | Compliance, multi-tenant, enterprise needs | PRD + Architecture + Security + DevOps | --- @@ -305,11 +306,11 @@ Explore related topics: Commands you learned in this tutorial: -| Command | Agent | Purpose | -| ---------------- | ------- | ---------------------------------- | -| `*workflow-init` | Analyst | Initialize a new project | -| `*prd` | PM | Create a Product Requirements Document | -| `workflow-status`| Any | Check progress and next steps | +| Command | Agent | Purpose | +| ----------------- | ------- | -------------------------------------- | +| `*workflow-init` | Analyst | Initialize a new project | +| `*prd` | PM | Create a Product Requirements Document | +| `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. diff --git a/docs/tutorials/getting-started/quick-start-bmgd.md b/docs/tutorials/getting-started/quick-start-bmgd.md index 07e456d7..e9ab0494 100644 --- a/docs/tutorials/getting-started/quick-start-bmgd.md +++ b/docs/tutorials/getting-started/quick-start-bmgd.md @@ -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. diff --git a/docs/tutorials/getting-started/quick-start-bmm.md b/docs/tutorials/getting-started/quick-start-bmm.md index bf65b6ed..6b1b6244 100644 --- a/docs/tutorials/getting-started/quick-start-bmm.md +++ b/docs/tutorials/getting-started/quick-start-bmm.md @@ -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. diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md deleted file mode 100644 index e92e4d47..00000000 --- a/docs/tutorials/index.md +++ /dev/null @@ -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 diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 32ab8182..58a2bbbe 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -116,7 +116,7 @@ const config = { items: [ { type: 'doc', - docId: 'tutorials/index', + docId: 'tutorials/getting-started/bmad-tutorial', position: 'left', label: 'Tutorials', }, diff --git a/website/sidebars.js b/website/sidebars.js index 8c852ce0..89dc072a 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -13,7 +13,6 @@ const sidebars = { type: 'category', label: 'Tutorials', collapsed: false, - link: { type: 'doc', id: 'tutorials/index' }, items: [{ type: 'autogenerated', dirName: 'tutorials' }], }, {