Skip to content

fix: docs llms order, bmgd draft, tea link#1525

Merged
pbean merged 2 commits intomainfrom
fix/docs-llms-order-tea-link
Feb 4, 2026
Merged

fix: docs llms order, bmgd draft, tea link#1525
pbean merged 2 commits intomainfrom
fix/docs-llms-order-tea-link

Conversation

@muratkeremozcan
Copy link
Copy Markdown
Contributor

Docs cleanup + references:

  • hide BMGD pages from main docs/llms,
  • add Testing Options + Agents + Commands reference pages,
  • adjust llms-full ordering/excludes

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

The PR marks three BMGD documentation files as draft, adds three new reference documentation pages covering agents, commands, and testing options, updates a QA agent menu trigger label, and implements deterministic sorting for documentation assembly in the build process.

Changes

Cohort / File(s) Summary
Documentation Metadata Updates
docs/bmgd/game-types.md, docs/bmgd/index.md, docs/bmgd/quick-flow-workflows.md
Added draft: true front-matter metadata to mark BMGD guides as drafts; removed empty trailing bullet from index file.
New Reference Documentation
docs/reference/agents.md, docs/reference/commands.md, docs/reference/testing.md
Added three new reference pages documenting default BMM agents with menu triggers, BMAD command discovery and generation, and testing paradigms (Quinn QA and Test Architect module).
QA Agent Configuration
src/bmm/agents/qa.agent.yaml
Updated menu trigger from "qa" to "QA or fuzzy match on qa-automate" to provide clearer activation description.
Build Documentation Assembly
tools/build-docs.js
Implemented deterministic sorting for Markdown files in llms-full.txt generation using new compareLlmDocs and getLlmSortKey functions with precedence order: index.md, downloads.md, tutorials, how-to, explanation, reference, bmgd, others.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: ordering fix for llms, marking BMGD pages as draft, and adding Tea/testing references. It is concise and specific.
Description check ✅ Passed The description is directly related to the changeset, detailing the documentation cleanup, hiding BMGD pages, adding reference pages, and adjusting ordering—all present in the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 fix/docs-llms-order-tea-link

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

  • 136.113.208.247/32 (new)
  • 34.170.211.100/32
  • 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.


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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
tools/build-docs.js (2)

33-42: ⚠️ Potential issue | 🟡 Minor

Fix exclude pattern matching for Windows path separators.

On Windows, path.relative() returns backslashes, so patterns containing forward slashes (e.g., bmgd/) won't match in the .includes() check at line 296, allowing excluded docs to leak into llms-full.txt. The code already uses a defensive dual-check pattern in getLlmSortKey() (lines 251–256). Apply the same pattern to shouldExcludeFromLlm():

Suggested fix
function shouldExcludeFromLlm(filePath) {
  // Exclude if ANY path component starts with underscore
  // (e.g., _STYLE_GUIDE.md, _archive/file.md, dir/_STYLE_GUIDE.md)
  const pathParts = filePath.split(path.sep);
  if (pathParts.some((part) => part.startsWith('_'))) return true;

  // Check configured patterns (handle both forward slashes and platform-specific separators)
  return LLM_EXCLUDE_PATTERNS.some((pattern) => {
    // Normalize pattern for platform-specific comparison
    const normalizedPattern = pattern.replace(/\//g, path.sep);
    return filePath.includes(pattern) || filePath.includes(normalizedPattern);
  });
}

198-245: ⚠️ Potential issue | 🟡 Minor

Use a fixed locale for deterministic ordering.

The localeCompare() call without an explicit locale uses the host environment's default locale, making file ordering non-deterministic across environments. Since this function generates documentation for LLM consumption, consistent output across build environments matters. Apply this fix:

  return a.localeCompare(b, 'en');
🤖 Fix all issues with AI agents
In `@docs/reference/agents.md`:
- Line 19: Update the docs table entry that currently shows the trigger as `qa`
to match the updated agent config which uses `QA` (and supports fuzzy matching
like `qa-automate`); change the trigger cell for "QA Engineer (Quinn)" from `qa`
to `QA` in docs/reference/agents.md so it reflects the actual setting in
qa.agent.yaml and the new fuzzy-match behavior.

@alexeyv
Copy link
Copy Markdown
Collaborator

alexeyv commented Feb 4, 2026

I have further documentation changes, even a branch in the works that does half of what this PR does, but directionally, I like this PR and the best way to move forward is to merge it and I will then submit my changes on top.

Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merge

@pbean pbean merged commit 11d2fc6 into main Feb 4, 2026
5 checks passed
@alexeyv alexeyv deleted the fix/docs-llms-order-tea-link branch February 22, 2026 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants