Skip to content

fix(docs): point llms.txt links to real pages#34

Open
VPhung24 wants to merge 1 commit into
bmad-code-org:mainfrom
VPhung24:fix/llms-txt-broken-urls
Open

fix(docs): point llms.txt links to real pages#34
VPhung24 wants to merge 1 commit into
bmad-code-org:mainfrom
VPhung24:fix/llms-txt-broken-urls

Conversation

@VPhung24
Copy link
Copy Markdown

@VPhung24 VPhung24 commented May 4, 2026

Summary

The hardcoded URLs in tools/build-docs.mjs generateLlmsTxt() referenced pages that don't exist in docs/, so the published llms.txt (https://cis-docs.bmad-method.org/llms.txt) shipped 404 links. This swaps them for real pages.

Before (404) After (200)
/tutorials/quick-start /tutorials/getting-started/
/reference/installation /reference/configuration/
/explanation/what-is-cis /explanation/creative-intelligence/
/how-to/brainstorm /how-to/brainstorm/ (added trailing slash)
/how-to/solve-problems /how-to/problem-solving/

Test plan

  • All five replacement URLs return HTTP 200 against the live site
  • CI builds green
  • After merge + Pages deploy, verify /llms.txt no longer contains the four 404 paths

Summary by CodeRabbit

  • Documentation
    • Updated navigation structure with new sections: "Getting Started," "Configuration," and "Creative Intelligence." Replaced previous Quick Start and conceptual guidance paths to improve documentation organization and accessibility.

Why: the hardcoded URLs in generateLlmsTxt() referenced pages that
don't exist (quick-start, installation, what-is-cis, solve-problems),
producing 404s for anyone — human or LLM — following them.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a3514a8d-6a09-4a0a-868c-cccfbe799539

📥 Commits

Reviewing files that changed from the base of the PR and between c2ad6c4 and 28bea57.

📒 Files selected for processing (1)
  • tools/build-docs.mjs

Walkthrough

The generateLlmsTxt() function in the build-docs script is updated to generate LLM navigation links with new site URL slugs: "Getting Started" and "Configuration" replace old Quick Start entries, and "Creative Intelligence" replaces the prior "What is CIS" concept link. Route trailing slashes are also adjusted.

Changes

Navigation URL Updates

Layer / File(s) Summary
LLM Navigation Content
tools/build-docs.mjs
Quick Start section updated from tutorials/quick-start and reference/installation to tutorials/getting-started/ and reference/configuration/. Core Concepts section updated from explanation/what-is-cis and problem-solving routes to explanation/creative-intelligence/, how-to/brainstorm/, and how-to/problem-solving/.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit bounces through the docs with glee,
New paths and slugs dance merrily!
"Getting Started" hops into view,
Creative Intelligence shines anew.
One file tweaked, the navigation glows,
Off down the garden path it goes! 🌱

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: fixing broken links in llms.txt to point to real pages.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

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.

1 participant