From b877021146f457d938c1552cc941613b5ee93116 Mon Sep 17 00:00:00 2001 From: Alex Verkhovsky Date: Fri, 6 Feb 2026 06:14:19 -0700 Subject: [PATCH] docs: add description front matter to documentation pages --- docs/_STYLE_GUIDE.md | 1 + docs/bmgd/game-types.md | 1 + docs/bmgd/quick-flow-workflows.md | 1 + docs/downloads.md | 1 + docs/how-to/customize-bmad.md | 1 + docs/how-to/shard-large-documents.md | 1 + docs/index.md | 1 + docs/reference/agents.md | 1 + docs/reference/modules.md | 1 + docs/reference/testing.md | 1 + 10 files changed, 10 insertions(+) diff --git a/docs/_STYLE_GUIDE.md b/docs/_STYLE_GUIDE.md index 3e78387af..801314cd0 100644 --- a/docs/_STYLE_GUIDE.md +++ b/docs/_STYLE_GUIDE.md @@ -1,5 +1,6 @@ --- title: "Documentation Style Guide" +description: Project-specific documentation conventions based on Google style and Diataxis structure --- This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow. diff --git a/docs/bmgd/game-types.md b/docs/bmgd/game-types.md index 2ea407218..87870ea10 100644 --- a/docs/bmgd/game-types.md +++ b/docs/bmgd/game-types.md @@ -1,5 +1,6 @@ --- title: "Game Types Reference" +description: 24 game type templates with genre-specific GDD sections for BMGD draft: true --- diff --git a/docs/bmgd/quick-flow-workflows.md b/docs/bmgd/quick-flow-workflows.md index 69ac7506a..239f263a6 100644 --- a/docs/bmgd/quick-flow-workflows.md +++ b/docs/bmgd/quick-flow-workflows.md @@ -1,5 +1,6 @@ --- title: "Quick Flow Workflows" +description: Create tech specs and execute implementations with BMGD Quick Flow draft: true --- diff --git a/docs/downloads.md b/docs/downloads.md index d063c8e10..ba9cee991 100644 --- a/docs/downloads.md +++ b/docs/downloads.md @@ -1,5 +1,6 @@ --- title: Downloads +description: Download BMad Method source bundles, prompts, and LLM-optimized documentation files --- Download BMad Method resources for offline use, AI training, or integration. diff --git a/docs/how-to/customize-bmad.md b/docs/how-to/customize-bmad.md index f23a101c6..3c356373f 100644 --- a/docs/how-to/customize-bmad.md +++ b/docs/how-to/customize-bmad.md @@ -1,5 +1,6 @@ --- title: "BMad Method Customization Guide" +description: Customize agents, workflows, and modules while preserving update compatibility --- The ability to customize the BMad Method and its core to your needs, while still being able to get updates and enhancements is a critical idea within the BMad Ecosystem. diff --git a/docs/how-to/shard-large-documents.md b/docs/how-to/shard-large-documents.md index a8cabc5b3..fee59e504 100644 --- a/docs/how-to/shard-large-documents.md +++ b/docs/how-to/shard-large-documents.md @@ -1,5 +1,6 @@ --- title: "Document Sharding Guide" +description: Split large markdown files into smaller organized files for better context management --- Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management. diff --git a/docs/index.md b/docs/index.md index 3dcf5cd0e..9d33895a7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- title: Welcome to the BMad Method +description: AI-driven development framework with specialized agents, guided workflows, and intelligent planning --- The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform. diff --git a/docs/reference/agents.md b/docs/reference/agents.md index 00a2da9d5..87a0927c3 100644 --- a/docs/reference/agents.md +++ b/docs/reference/agents.md @@ -1,5 +1,6 @@ --- title: Agents +description: Default BMM agents with their menu triggers and primary workflows --- This page lists the default BMM (Agile suite) agents that install with BMAD Method, along with their menu triggers and primary workflows. diff --git a/docs/reference/modules.md b/docs/reference/modules.md index c1b9c497e..a0f6fdd6f 100644 --- a/docs/reference/modules.md +++ b/docs/reference/modules.md @@ -1,5 +1,6 @@ --- title: Official Modules +description: Add-on modules for building custom agents, creative intelligence, game development, and testing --- BMad extends through official modules that you select during installation. These add-on modules provide specialized agents, workflows, and tasks for specific domains beyond the built-in core and BMM (Agile suite). diff --git a/docs/reference/testing.md b/docs/reference/testing.md index 562526fb2..86af5294b 100644 --- a/docs/reference/testing.md +++ b/docs/reference/testing.md @@ -1,5 +1,6 @@ --- title: Testing Options +description: Built-in QA agent and the standalone Test Architect module for advanced testing --- # Testing Options