feat: add documentation website with Docusaurus build pipeline (#1177)

* feat: add documentation website with Docusaurus build pipeline

* feat(docs): add AI discovery meta tags for llms.txt files

- Add global headTags with ai-terms, llms, llms-full meta tags
- Update landing page link to clarify AI context purpose

* fix(docs): restore accidentally deleted faq.md and glossary.md

Files were removed in 12dd97f during path restructuring.

* fix(docs): update broken project-readme links to GitHub URL

* feat(schema): add compound trigger format validation

Author: alexeyv

.github/workflows/docs.yaml

@@ -0,0 +1,72 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "src/modules/*/docs/**"
+      - "website/**"
+      - "tools/build-docs.js"
+      - ".github/workflows/docs.yaml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Determine site URL
+        id: site-url
+        run: |
+          if [ "${{ github.repository }}" = "bmad-code-org/BMAD-METHOD" ]; then
+            echo "url=https://bmad-code-org.github.io/BMAD-METHOD" >> $GITHUB_OUTPUT
+          else
+            OWNER="${{ github.repository_owner }}"
+            REPO="${{ github.event.repository.name }}"
+            echo "url=https://${OWNER}.github.io/${REPO}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Build documentation
+        env:
+          SITE_URL: ${{ steps.site-url.outputs.url }}
+        run: npm run docs:build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build/site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -74,4 +74,8 @@ _bmad
 .kiro/
 .roo
 
-bmad-custom-src/
+bmad-custom-src/
+
+# Docusaurus / Documentation Build
+.docusaurus/
+build/

CONTRIBUTING.md

@@ -236,10 +236,8 @@ Each commit should represent one logical change:
 3. **Don't paste code in issues** - create a proper PR instead
 4. **Don't submit your whole project** - contribute specific improvements
 
-## Code Style
+## Prompt & Agent Guidelines
 
-- Follow the existing code style and conventions
-- Write clear comments for complex logic
 - Keep dev agents lean - they need context for coding, not documentation
 - Web/planning agents can be larger with more complex tasks
 - Everything is natural language (markdown) - no code in core framework

README.md

@@ -26,8 +26,8 @@ The completely revamped **BMAD V6 installer** now includes built-in support for
 
 - [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types
 - [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content
-- [**Detail Content Docs**](./src/modules/bmb/docs/README.md) - Reference details for agents, modules, workflows and the bmad builder
-- [**2 Very simple Custom Modules of questionable quality**](./docs/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
+- [**Detail Content Docs**](./src/modules/bmb/docs/index.md) - Reference details for agents, modules, workflows and the bmad builder
+- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
 
 </div>
 
@@ -142,18 +142,17 @@ Each agent brings deep expertise and can be customized to match your team's styl
   - 12 specialized agents
   - 34 workflows across 4 phases
   - Scale-adaptive planning
-  - [→ Documentation Hub](./src/modules/bmm/docs/README.md)
+  - [→ Documentation Hub](./src/modules/bmm/docs/index.md)
 
 - **BMad Builder (BMB)** - Create custom agents and workflows
   - Build anything from simple agents to complex modules
   - Create domain-specific solutions (legal, medical, finance, education)
-  - [→ Builder Guide](src/modules/bmb/docs/README.md) marketplace
-  - [→ Builder Guide](./src/modules/bmb/README.md)
+  - [→ Builder Guide](./src/modules/bmb/docs/index.md)
 
 - **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
   - Brainstorming, design thinking, storytelling
   - 5 creative facilitation workflows
-  - [→ Creative Workflows](src/modules/cis/docs/README.md)
+  - [→ Creative Workflows](./src/modules/cis/docs/index.md)
 
 ### Key Features
 
@@ -168,7 +167,7 @@ Each agent brings deep expertise and can be customized to match your team's styl
 ### Quick Links
 
 - **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
-- **[Complete BMM Documentation](./src/modules/bmm/docs/README.md)** - All guides and references
+- **[Complete BMM Documentation](./src/modules/bmm/docs/index.md)** - All guides and references
 - **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents
 - **[All Documentation](./docs/index.md)** - Complete documentation index
 

docs/agent-customization-guide.md

@@ -203,6 +203,6 @@ memories:
 
 ## Next Steps
 
-- **[BMM Agents Guide](../src/modules/bmm/docs/agents-guide.md)** - Learn about the BMad Method agents
-- **[BMB Create Agent Workflow](../src/modules/bmb/workflows/create-agent/README.md)** - Build completely custom agents
-- **[BMM Complete Documentation](../src/modules/bmm/docs/README.md)** - Full BMad Method reference
+- **[BMM Agents Guide](./modules/bmm/agents-guide)** - Learn about the BMad Method agents
+- **[BMB Create Agent Workflow](./modules/bmb/agents/index)** - Build completely custom agents
+- **[BMM Complete Documentation](./modules/bmm/index)** - Full BMad Method reference

docs/custom-content-installation.md

@@ -4,7 +4,7 @@ This guide explains how to create and install custom BMAD content including agen
 
 For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md).
 
-If you download either of the folders within the [Sample Custom Modules](./sample-custom-modules/readme.md) folder
+You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out.
 
 ## Content Types Overview
 

docs/document-sharding-guide.md

@@ -441,8 +441,8 @@ input_file_patterns:
 ## Related Documentation
 
 - [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation
-- [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Workflow overview
-- [Workflow Creation Guide](../src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md) - Custom workflow patterns
+- [BMM Workflows Guide](./modules/bmm/index.md#-workflow-guides) - Workflow overview
+- [Workflow Creation Guide](./modules/bmb/workflows/index) - Custom workflow patterns
 
 ---
 

docs/getting-started/installation.md

@@ -0,0 +1,76 @@
+# Installation
+
+Get BMAD Method running in your project in under 2 minutes.
+
+## Quick Install
+
+```bash
+npx bmad-method@alpha install
+```
+
+This interactive installer will:
+
+1. Detect your IDE (Claude Code, Cursor, VS Code, etc.)
+2. Let you choose which modules to install
+3. Configure agents and workflows for your project
+
+## Requirements
+
+- **Node.js** 18+ (for the installer)
+- **Git** (recommended for version control)
+- An **AI-powered IDE** or access to Claude/ChatGPT/Gemini
+
+## Module Options
+
+During installation, you'll choose which modules to install:
+
+| Module   | Description      | Best For                                 |
+| -------- | ---------------- | ---------------------------------------- |
+| **BMM**  | BMAD Method Core | Software development projects            |
+| **BMGD** | Game Development | Game projects with specialized workflows |
+| **BMB**  | Builder          | Creating custom agents and workflows     |
+
+## Post-Installation
+
+After installation, your project will have:
+
+```
+your-project/
+├── _bmad/              # BMAD configuration and agents
+│   ├── bmm/            # Method module (if installed)
+│   ├── bmgd/           # Game dev module (if installed)
+│   └── config.yaml     # Your project configuration
+├── .claude/            # IDE-specific setup (varies by IDE)
+└── ... your code
+```
+
+## Next Steps
+
+1. **Read the [Quick Start Guide](../modules/bmm/quick-start.md)** to build your first feature
+2. **Check your [IDE Guide](../ide-info/index.md)** for IDE-specific tips
+3. **Explore [Workflows](../modules/bmm/workflows-planning.md)** to understand the methodology
+
+## Alternative: Web Bundles
+
+Don't want to install? Use BMAD agents directly in:
+
+- **Claude Projects** - Upload the web bundle
+- **ChatGPT** - Use custom GPT bundles
+- **Gemini** - Import agent prompts
+
+See the [Web Bundles Guide](../web-bundles-gemini-gpt-guide.md) for details.
+
+## Troubleshooting
+
+### Common Issues
+
+**"Command not found: npx"**
+: Install Node.js 18+ from [nodejs.org](https://nodejs.org)
+
+**"Permission denied"**
+: Run with appropriate permissions or check your npm configuration
+
+**IDE not detected**
+: The installer will prompt you to select your IDE manually
+
+For more help, see [Troubleshooting](../modules/bmm/troubleshooting.md) or join our [Discord](https://discord.gg/bmad).

docs/ide-info/index.md

@@ -0,0 +1,24 @@
+# IDE Guides
+
+BMAD Method works with any AI-powered development environment. Choose your IDE below for specific setup instructions and tips.
+
+## All Supported IDEs
+
+| IDE                                 | Type              | BMAD Support          |
+| ----------------------------------- | ----------------- | --------------------- |
+| [Claude Code](claude-code.md)       | CLI/Terminal      | Native slash commands |
+| [Cursor](cursor.md)                 | Desktop Editor    | Full agent support    |
+| [VS Code / Windsurf](windsurf.md)   | Desktop Editor    | Extension-based       |
+| [Cline](cline.md)                   | VS Code Extension | Full support          |
+| [GitHub Copilot](github-copilot.md) | Extension         | Workspace agents      |
+| [Augment](auggie.md)                | Extension         | Agent loading         |
+| [Codex](codex.md)                   | CLI               | Prompt injection      |
+| [Gemini](gemini.md)                 | Web/API           | Web bundles           |
+| [Roo](roo.md)                       | VS Code Extension | Mode support          |
+| [Kilo](kilo.md)                     | Extension         | Basic support         |
+| [OpenCode](opencode.md)             | Open Source       | Full support          |
+| [Qwen](qwen.md)                     | Web/API           | Web bundles           |
+| [Trae](trae.md)                     | Extension         | Basic support         |
+| [Crush](crush.md)                   | Desktop           | Agent support         |
+| [iFlow](iflow.md)                   | Extension         | Prompt loading        |
+| [Rovo Dev](rovo-dev.md)             | Atlassian         | Integration           |