Merge pull request #1525 from bmad-code-org/fix/docs-llms-order-tea-link
fix: docs llms order, bmgd draft, tea link
This commit is contained in:
PinkyD
GitHub
commit
11d2fc6d5e
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: "Game Types Reference"
|
||||
draft: true
|
||||
---
|
||||
|
||||
BMGD supports 24 game type templates. Each adds genre-specific sections to your GDD.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: "BMGD Quick Guide"
|
||||
description: Quick reference for BMad Game Dev Studio
|
||||
draft: true
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -110,4 +111,3 @@ Each template provides genre-specific GDD sections, mechanics patterns, testing
|
|||
|
||||
- [Game Types Guide](game-types.md)
|
||||
- [Quick-Flow Guide](quick-flow-workflows.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: "Quick Flow Workflows"
|
||||
draft: true
|
||||
---
|
||||
|
||||
How to create tech specs and execute implementations with Quick Flow.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: Agents
|
||||
---
|
||||
|
||||
This page lists the default BMM (Agile suite) agents that install with BMAD Method, along with their menu triggers and primary workflows.
|
||||
|
||||
Notes:
|
||||
- Triggers are the short menu codes (e.g., `CP`) and fuzzy matches shown in each agent menu.
|
||||
- Slash commands are generated separately. See `docs/reference/commands.md` for the slash command list and where they are defined.
|
||||
- QA (Quinn) is the lightweight test automation agent in BMM. The full Test Architect (TEA) lives in its own module.
|
||||
|
||||
| Agent | Triggers | Primary workflows |
|
||||
| --------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| Analyst (Mary) | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
||||
| Product Manager (John) | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
||||
| Architect (Winston) | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
||||
| Scrum Master (Bob) | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
||||
| Developer (Amelia) | `DS`, `CR` | Dev Story, Code Review |
|
||||
| QA Engineer (Quinn) | `QA` | Automate (generate tests for existing features) |
|
||||
| Quick Flow Solo Dev (Barry) | `QS`, `QD`, `CR` | Quick Spec, Quick Dev, Code Review |
|
||||
| UX Designer (Sally) | `CU` | Create UX Design |
|
||||
| Technical Writer (Paige) | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: Commands
|
||||
description: How BMAD commands are generated and where to find them.
|
||||
---
|
||||
|
||||
# Commands
|
||||
|
||||
BMAD slash commands are generated by the installer for your IDE and **reflect the modules you have installed**.
|
||||
That means the authoritative list lives **in your project**, not in a static docs page.
|
||||
|
||||
## How to Discover Commands (Recommended)
|
||||
|
||||
- Type `/bmad` in your IDE and use autocomplete to browse agents/workflows.
|
||||
- Run `/bmad-help` to get guided next steps and context-aware recommendations.
|
||||
|
||||
## Where Commands Are Generated
|
||||
|
||||
The installer writes command files into your project (example paths for Claude Code):
|
||||
|
||||
- `.claude/commands/bmad/<module>/agents/`
|
||||
- `.claude/commands/bmad/<module>/workflows/`
|
||||
|
||||
These folders are the **canonical, project-specific command list**.
|
||||
|
||||
## Common Commands
|
||||
|
||||
- `/bmad-help` - Interactive help and next-step guidance
|
||||
- `/bmad:<module>:agents:<agent>` - Load an agent (e.g. `/bmad:bmm:agents:dev`)
|
||||
- `/bmad:<module>:workflows:<workflow>` - Run a workflow (e.g. `/bmad:bmm:workflows:create-prd`)
|
||||
|
||||
## Why This Page Is Short
|
||||
|
||||
BMAD is modular, so the exact commands vary by install.
|
||||
Use your IDE's autocomplete or the generated command folders above to see *everything* available.
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: Testing Options
|
||||
---
|
||||
|
||||
# Testing Options
|
||||
|
||||
BMad provides a built-in QA agent for quick test automation and a separate Test Architect (TEA) module for advanced testing.
|
||||
|
||||
## Built-in QA (Quinn)
|
||||
|
||||
Use the built-in QA agent for fast, straightforward test coverage:
|
||||
|
||||
- Trigger: `QA` or `bmad-bmm-qa-automate`
|
||||
- Best for: small projects, quick coverage, standard patterns
|
||||
|
||||
## Test Architect (TEA) Module
|
||||
|
||||
TEA is a standalone module with advanced testing workflows (test design, ATDD, automate, review, trace, NFR assessment).
|
||||
|
||||
- Documentation: <https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/>
|
||||
- Install: `npx bmad-method@alpha install` and select the TEA module
|
||||
|
|
@ -27,7 +27,7 @@ agent:
|
|||
- Focus on realistic user scenarios
|
||||
|
||||
menu:
|
||||
- trigger: qa
|
||||
- trigger: QA or fuzzy match on qa-automate
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/qa/automate/workflow.yaml"
|
||||
description: "[QA] Automate - Generate tests for existing features (simplified)"
|
||||
|
||||
|
|
|
|||
|
|
@ -38,6 +38,7 @@ const LLM_EXCLUDE_PATTERNS = [
|
|||
'faq',
|
||||
'reference/glossary/',
|
||||
'explanation/game-dev/',
|
||||
'bmgd/',
|
||||
// Note: Files/dirs starting with _ (like _STYLE_GUIDE.md, _archive/) are excluded in shouldExcludeFromLlm()
|
||||
];
|
||||
|
||||
|
|
@ -194,7 +195,7 @@ function generateLlmsFullTxt(docsDir, outputDir) {
|
|||
console.log(' → Generating llms-full.txt...');
|
||||
|
||||
const date = new Date().toISOString().split('T')[0];
|
||||
const files = getAllMarkdownFiles(docsDir);
|
||||
const files = getAllMarkdownFiles(docsDir).sort(compareLlmDocs);
|
||||
|
||||
const output = [
|
||||
'# BMAD Method Documentation (Full)',
|
||||
|
|
@ -236,6 +237,25 @@ function generateLlmsFullTxt(docsDir, outputDir) {
|
|||
);
|
||||
}
|
||||
|
||||
function compareLlmDocs(a, b) {
|
||||
const aKey = getLlmSortKey(a);
|
||||
const bKey = getLlmSortKey(b);
|
||||
|
||||
if (aKey !== bKey) return aKey - bKey;
|
||||
return a.localeCompare(b);
|
||||
}
|
||||
|
||||
function getLlmSortKey(filePath) {
|
||||
if (filePath === 'index.md') return 0;
|
||||
if (filePath === 'downloads.md') return 1;
|
||||
if (filePath.startsWith(`tutorials${path.sep}`) || filePath.startsWith('tutorials/')) return 2;
|
||||
if (filePath.startsWith(`how-to${path.sep}`) || filePath.startsWith('how-to/')) return 3;
|
||||
if (filePath.startsWith(`explanation${path.sep}`) || filePath.startsWith('explanation/')) return 4;
|
||||
if (filePath.startsWith(`reference${path.sep}`) || filePath.startsWith('reference/')) return 5;
|
||||
if (filePath.startsWith(`bmgd${path.sep}`) || filePath.startsWith('bmgd/')) return 6;
|
||||
return 7;
|
||||
}
|
||||
|
||||
/**
|
||||
* Collects all Markdown (.md) files under a directory and returns their paths relative to a base directory.
|
||||
* @param {string} dir - Directory to search for Markdown files.
|
||||
|
|
|
|||
Loading…
Reference in New Issue