Skip to content

docs: stop the API reference link check flagging the llms.txt indexes the build writes - #25770

Merged
alejoamiras merged 2 commits into
nextfrom
docs-build-warnings
Nov 5, 2026
Merged

alejoamiras merged 2 commits into
nextfrom
docs-build-warnings

Conversation

@alejoamiras

Copy link
Copy Markdown
Contributor

What changed

  • The docs build no longer warns about two broken API reference links. Both point at the TypeScript API's llms.txt index, which production serves but the build writes only after the site is generated, so the link check, which runs earlier, never saw it.
  • The link check now gets the list of those indexes from the same code that writes them. A link to a missing API folder, a missing file, or an index the build does not write is still reported as broken.
  • A test covers both sides: indexes the build writes resolve, and the other three cases stay broken.

Not changed

  • The build still prints the llms-txt plugin's "Excluded N routes by current config" line. The plugin prints it whenever the configuration excludes any route, and the only setting that hides it (logLevel: 0) also hides the plugin's real warnings, such as unreadable pages or cache failures. The exclusions are intended: the historical v5.2.0 pages, search and tag pages, and the API reference folders, which get their own indexes.

… the build writes

The build writes a scoped llms.txt into each built API reference folder after
docusaurus runs, so the link check, which reads static/, reported the aztec.js
reference page's link to it as broken. The check now takes the list of those
indexes from the code that writes them; missing folders, missing files and
indexes the build does not write stay broken.
…option

A source URL like /-e<api dir>/llms.txt resolved because grep took it as -e.
@alejoamiras
alejoamiras requested a review from a team as a code owner November 5, 2026 18:26
@alejoamiras
alejoamiras merged commit 6ab210a into next Nov 5, 2026
16 checks passed
@alejoamiras
alejoamiras deleted the docs-build-warnings branch November 5, 2026 19:47
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.

2 participants