Skip to content

Commit 87b1292

Browse files
muratkeremozcanmuratkeremozcan
authored
docs: named TEA links consistently (#1337)
1 parent 43f7eee commit 87b1292

4 files changed

Lines changed: 84 additions & 19 deletions

File tree

‎docs/explanation/features/tea-overview.md‎

Lines changed: 70 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ If you are unsure, default to the integrated path for your track and adjust late
5555

5656
## TEA Command Catalog
5757

58-
| Command | Primary Outputs | Notes | With Playwright MCP Enhancements |
59-
| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
60-
| `*framework` | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - |
61-
| `*ci` | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - |
62-
| `*test-design` | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
63-
| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: UI selectors verified with live browser; API tests benefit from trace analysis |
58+
| Command | Primary Outputs | Notes | With Playwright MCP Enhancements |
59+
| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
60+
| `*framework` | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - |
61+
| `*ci` | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - |
62+
| `*test-design` | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
63+
| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: UI selectors verified with live browser; API tests benefit from trace analysis |
6464
| `*automate` | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Visual debugging + trace analysis for test fixes; **+ Recording**: Verified selectors (UI) + network inspection (API) |
65-
| `*test-review` | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - |
66-
| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - |
67-
| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
65+
| `*test-review` | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - |
66+
| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - |
67+
| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
6868

6969
## TEA Workflow Lifecycle
7070

@@ -173,12 +173,12 @@ TEA spans multiple phases (Phase 3, Phase 4, and the release gate). Most BMM age
173173

174174
### TEA's 8 Workflows Across Phases
175175

176-
| Phase | TEA Workflows | Frequency | Purpose |
177-
| ----------- | --------------------------------------------------------- | ---------------- | ---------------------------------------------- |
178-
| **Phase 2** | (none) | - | Planning phase - PM defines requirements |
176+
| Phase | TEA Workflows | Frequency | Purpose |
177+
| ----------- | --------------------------------------------------------- | ---------------- | ------------------------------------------------------- |
178+
| **Phase 2** | (none) | - | Planning phase - PM defines requirements |
179179
| **Phase 3** | \*test-design (system-level), \*framework, \*ci | Once per project | System testability review and test infrastructure setup |
180-
| **Phase 4** | \*test-design, \*atdd, \*automate, \*test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing |
181-
| **Release** | \*nfr-assess, \*trace (Phase 2: gate) | Per epic/release | Go/no-go decision |
180+
| **Phase 4** | \*test-design, \*atdd, \*automate, \*test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing |
181+
| **Release** | \*nfr-assess, \*trace (Phase 2: gate) | Per epic/release | Go/no-go decision |
182182

183183
**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow.
184184

@@ -352,3 +352,59 @@ Live browser verification for test design and automation.
352352
- Enhances healing with `browser_snapshot`, console, network, and locator tools.
353353

354354
**To disable**: set `tea_use_mcp_enhancements: false` in `_bmad/bmm/config.yaml` or remove MCPs from IDE config.
355+
356+
---
357+
358+
## Complete TEA Documentation Navigation
359+
360+
### Start Here
361+
362+
**New to TEA? Start with the tutorial:**
363+
- [TEA Lite Quickstart Tutorial](/docs/tutorials/getting-started/tea-lite-quickstart.md) - 30-minute beginner guide using TodoMVC
364+
365+
### Workflow Guides (Task-Oriented)
366+
367+
**All 8 TEA workflows with step-by-step instructions:**
368+
1. [How to Set Up a Test Framework with TEA](/docs/how-to/workflows/setup-test-framework.md) - Scaffold Playwright or Cypress
369+
2. [How to Set Up CI Pipeline with TEA](/docs/how-to/workflows/setup-ci.md) - Configure CI/CD with selective testing
370+
3. [How to Run Test Design with TEA](/docs/how-to/workflows/run-test-design.md) - Risk-based test planning (system or epic)
371+
4. [How to Run ATDD with TEA](/docs/how-to/workflows/run-atdd.md) - Generate failing tests before implementation
372+
5. [How to Run Automate with TEA](/docs/how-to/workflows/run-automate.md) - Expand test coverage after implementation
373+
6. [How to Run Test Review with TEA](/docs/how-to/workflows/run-test-review.md) - Audit test quality (0-100 scoring)
374+
7. [How to Run NFR Assessment with TEA](/docs/how-to/workflows/run-nfr-assess.md) - Validate non-functional requirements
375+
8. [How to Run Trace with TEA](/docs/how-to/workflows/run-trace.md) - Coverage traceability + gate decisions
376+
377+
### Customization & Integration
378+
379+
**Optional enhancements to TEA workflows:**
380+
- [Integrate Playwright Utils](/docs/how-to/customization/integrate-playwright-utils.md) - Production-ready fixtures and 9 utilities
381+
- [Enable TEA MCP Enhancements](/docs/how-to/customization/enable-tea-mcp-enhancements.md) - Live browser verification, visual debugging
382+
383+
### Use-Case Guides
384+
385+
**Specialized guidance for specific contexts:**
386+
- [Using TEA with Existing Tests (Brownfield)](/docs/how-to/brownfield/use-tea-with-existing-tests.md) - Incremental improvement, regression hotspots, baseline coverage
387+
- [Running TEA for Enterprise](/docs/how-to/enterprise/use-tea-for-enterprise.md) - Compliance, NFR assessment, audit trails, SOC 2/HIPAA
388+
389+
### Concept Deep Dives (Understanding-Oriented)
390+
391+
**Understand the principles and patterns:**
392+
- [Risk-Based Testing](/docs/explanation/tea/risk-based-testing.md) - Probability × impact scoring, P0-P3 priorities, mitigation strategies
393+
- [Test Quality Standards](/docs/explanation/tea/test-quality-standards.md) - Definition of Done, determinism, isolation, explicit assertions
394+
- [Fixture Architecture](/docs/explanation/tea/fixture-architecture.md) - Pure function → fixture → composition pattern
395+
- [Network-First Patterns](/docs/explanation/tea/network-first-patterns.md) - Intercept-before-navigate, eliminating flakiness
396+
- [Knowledge Base System](/docs/explanation/tea/knowledge-base-system.md) - Context engineering with tea-index.csv, 33 fragments
397+
- [Engagement Models](/docs/explanation/tea/engagement-models.md) - TEA Lite, TEA Solo, TEA Integrated (5 models explained)
398+
399+
### Philosophy & Design
400+
401+
**Why TEA exists and how it works:**
402+
- [Testing as Engineering](/docs/explanation/philosophy/testing-as-engineering.md) - **Start here to understand WHY** - The problem with AI-generated tests and TEA's three-part solution
403+
404+
### Reference (Quick Lookup)
405+
406+
**Factual information for quick reference:**
407+
- [TEA Command Reference](/docs/reference/tea/commands.md) - All 8 workflows: inputs, outputs, phases, frequency
408+
- [TEA Configuration Reference](/docs/reference/tea/configuration.md) - Config options, file locations, setup examples
409+
- [Knowledge Base Index](/docs/reference/tea/knowledge-base.md) - 33 fragments categorized and explained
410+
- [Glossary - TEA Section](/docs/reference/glossary/index.md#test-architect-tea-concepts) - 20 TEA-specific terms defined

‎docs/how-to/workflows/run-test-design.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "How to Run Test Design"
2+
title: "How to Run Test Design with TEA"
33
description: How to create comprehensive test plans using TEA's test-design workflow
44
---
55

‎docs/how-to/workflows/setup-test-framework.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "How to Set Up a Test Framework"
2+
title: "How to Set Up a Test Framework with TEA"
33
description: How to set up a production-ready test framework using TEA
44
---
55

‎tools/build-docs.js‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ const BUILD_DIR = path.join(PROJECT_ROOT, 'build');
2424
const SITE_URL = process.env.SITE_URL || 'https://bmad-code-org.github.io/BMAD-METHOD';
2525
const REPO_URL = 'https://github.com/bmad-code-org/BMAD-METHOD';
2626

27+
// DO NOT CHANGE THESE VALUES!
28+
// llms-full.txt is consumed by AI agents as context. Most LLMs have ~200k token limits.
29+
// 600k chars ≈ 150k tokens (safe margin). Exceeding this breaks AI agent functionality.
2730
const LLM_MAX_CHARS = 600_000;
2831
const LLM_WARN_CHARS = 500_000;
2932

@@ -33,10 +36,9 @@ const LLM_EXCLUDE_PATTERNS = [
3336
'v4-to-v6-upgrade',
3437
'downloads/',
3538
'faq',
36-
'_STYLE_GUIDE.md',
37-
'_archive/',
3839
'reference/glossary/',
3940
'explanation/game-dev/',
41+
// Note: Files/dirs starting with _ (like _STYLE_GUIDE.md, _archive/) are excluded in shouldExcludeFromLlm()
4042
];
4143

4244
// =============================================================================
@@ -260,10 +262,17 @@ function getAllMarkdownFiles(dir, baseDir = dir) {
260262

261263
/**
262264
* Determine whether a file path matches any configured LLM exclusion pattern.
265+
* Also excludes any files or directories starting with underscore.
263266
* @param {string} filePath - The file path to test.
264-
* @returns {boolean} `true` if the path contains any pattern from LLM_EXCLUDE_PATTERNS, `false` otherwise.
267+
* @returns {boolean} `true` if excluded, `false` otherwise.
265268
*/
266269
function shouldExcludeFromLlm(filePath) {
270+
// Exclude if ANY path component starts with underscore
271+
// (e.g., _STYLE_GUIDE.md, _archive/file.md, dir/_STYLE_GUIDE.md)
272+
const pathParts = filePath.split(path.sep);
273+
if (pathParts.some((part) => part.startsWith('_'))) return true;
274+
275+
// Check configured patterns
267276
return LLM_EXCLUDE_PATTERNS.some((pattern) => filePath.includes(pattern));
268277
}
269278

0 commit comments

Comments
 (0)