docs: named TEA links consistently

[muratkeremozcan]

Add TEA documentation navigation section and improve LLM exclusion logic.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates documentation titles to include "with TEA" suffix for consistency, reformats the TEA Command Catalog table in the overview document, adds a comprehensive documentation navigation section, and modifies the build-docs.js tooling to introduce LLM character limits and implement underscore-based path exclusion logic.

Changes

Cohort / File(s)	Summary
Documentation Title Updates docs/how-to/workflows/run-test-design.md, docs/how-to/workflows/setup-test-framework.md	Updated page titles to include "with TEA" suffix for consistency across how-to guides.
TEA Overview Documentation docs/explanation/features/tea-overview.md	Reformatted TEA Command Catalog table with standardized header/footer rows using plus-prefixed separators. Added comprehensive "Complete TEA Documentation Navigation" section with multi-subsection navigation hub (Start Here, Workflows, Customization, Use-Case Guides, Deep Dives, Philosophy, Reference). Adjusted phase and release tables for consistent spacing.
Documentation Build Tooling tools/build-docs.js	Added LLM_MAX_CHARS (600,000) and LLM_WARN_CHARS (500,000) constants. Removed _STYLE_GUIDE.md and _archive/ from LLM_EXCLUDE_PATTERNS. Introduced explicit underscore-based path component exclusion in shouldExcludeFromLlm logic (runs before pattern checks).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• docs: tea editorial review #1313: Overlapping edits to tea-overview.md command catalog and phase table reformatting.
• docs: fix docs build #1336: Related modification to tools/build-docs.js LLM constants and behavior.
• Add link auditor, reorganize documentation, and README update #1277: Similar underscore-prefixed exclusion logic added to documentation tooling (_* pattern exclusion).

Suggested reviewers

• alexeyv
• bmadcode

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title 'docs: named TEA links consistently' does not accurately reflect the main changes, which include adding navigation sections, updating documentation titles, and modifying LLM exclusion logic.	Update the title to better describe the primary changes, such as 'docs: add TEA navigation hub and improve LLM exclusion logic' or similar.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is related to the changeset, mentioning both the TEA documentation navigation section addition and LLM exclusion logic improvements, which align with the actual changes.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/tea-link-naming

---

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43f7eee and 476e3ac.

📒 Files selected for processing (4)

• docs/explanation/features/tea-overview.md
• docs/how-to/workflows/run-test-design.md
• docs/how-to/workflows/setup-test-framework.md
• tools/build-docs.js

🧰 Additional context used

📓 Path-based instructions (2)

**/*

⚙️ CodeRabbit configuration file

**/*: Focus on inconsistencies, contradictions, edge cases and serious issues.
Avoid commenting on minor issues such as linting, formatting and style issues.
When providing code suggestions, use GitHub's suggestion format:

<code changes>

Files:

• docs/how-to/workflows/run-test-design.md
• docs/explanation/features/tea-overview.md
• tools/build-docs.js
• docs/how-to/workflows/setup-test-framework.md

**/*.js

⚙️ CodeRabbit configuration file

**/*.js: CLI tooling code. Check for: missing error handling on fs operations,
path.join vs string concatenation, proper cleanup in error paths.
Flag any process.exit() without error message.

Files:

• tools/build-docs.js

🪛 LanguageTool

docs/explanation/features/tea-overview.md

[style] ~397-~397: The words ‘explanation’ and ‘explained’ are quite similar. Consider replacing ‘explained’ with a different word.
Context: ...ite, TEA Solo, TEA Integrated (5 models explained) ### Philosophy & Design **Why TEA ex...

(VERB_NOUN_SENT_LEVEL_REP)

🔇 Additional comments (8)

docs/how-to/workflows/setup-test-framework.md (1)

1-4: LGTM!

Title update to "How to Set Up a Test Framework with TEA" aligns with the PR objective of consistent TEA link naming across documentation.

docs/how-to/workflows/run-test-design.md (1)

1-4: LGTM!

Title update maintains consistency with other TEA workflow documentation titles.

tools/build-docs.js (3)

27-31: LGTM!

The LLM character limits are well-documented with clear rationale. The warning comment helps prevent accidental modifications that could break AI agent functionality.

---

33-42: LGTM!

Good refactoring—removing specific underscore-prefixed patterns in favor of the generic underscore exclusion rule reduces maintenance burden and ensures consistency.

---

269-277: Clean implementation of underscore-based exclusion.

The logic correctly handles nested paths (e.g., dir/_archive/file.md) by checking all path components. Using path.sep ensures cross-platform compatibility since path.relative returns OS-specific separators.

docs/explanation/features/tea-overview.md (3)

58-67: LGTM!

Table reformatting improves readability with consistent column alignment.

---

176-181: LGTM!

Phase table formatting is consistent with the Command Catalog table above.

---

355-409: Navigation hub is well-structured with valid links.

The section provides excellent discoverability following the Diátaxis documentation framework. All referenced documentation files exist in the repository, including:

• /docs/how-to/brownfield/use-tea-with-existing-tests.md
• /docs/how-to/enterprise/use-tea-for-enterprise.md
• /docs/how-to/customization/integrate-playwright-utils.md
• /docs/how-to/customization/enable-tea-mcp-enhancements.md

All 24 links referenced across workflows, customization, use-case guides, concept deep dives, philosophy, and reference sections are present and valid.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}