docs: add description front matter to documentation pages
This commit is contained in:
Alex Verkhovsky
parent
8be3713595
commit
ff05393b0e
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Documentation Style Guide"
|
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.
|
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.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Game Types Reference"
|
title: "Game Types Reference"
|
||||||
|
description: 24 game type templates with genre-specific GDD sections for BMGD
|
||||||
draft: true
|
draft: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Quick Flow Workflows"
|
title: "Quick Flow Workflows"
|
||||||
|
description: Create tech specs and execute implementations with BMGD Quick Flow
|
||||||
draft: true
|
draft: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Downloads
|
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.
|
Download BMad Method resources for offline use, AI training, or integration.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "BMad Method Customization Guide"
|
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.
|
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.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Document Sharding Guide"
|
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.
|
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Welcome to the BMad Method
|
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.
|
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.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Agents
|
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.
|
This page lists the default BMM (Agile suite) agents that install with BMAD Method, along with their menu triggers and primary workflows.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Official Modules
|
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).
|
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).
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Testing Options
|
title: Testing Options
|
||||||
|
description: Built-in QA agent and the standalone Test Architect module for advanced testing
|
||||||
---
|
---
|
||||||
|
|
||||||
# Testing Options
|
# Testing Options
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue