Skip to content

AFDocs fixes: improve llms-txt-coverage with complete customSets#41

Merged
rachaelrenk merged 3 commits intomainfrom
afdocs-fixes
May 8, 2026
Merged

AFDocs fixes: improve llms-txt-coverage with complete customSets#41
rachaelrenk merged 3 commits intomainfrom
afdocs-fixes

Conversation

@rachaelrenk
Copy link
Copy Markdown
Contributor

@rachaelrenk rachaelrenk commented May 8, 2026

AFDocs fixes: improve llms-txt-coverage

Problem

The AFDocs audit scored docs.warp.dev at 81/100 (B-) with the llms-txt-coverage check warning that only 253/314 sitemap pages (81%) were covered by llms.txt custom sets.

Root cause

  • The support-and-community custom set manually listed individual page paths, missing warp-preview-and-alpha-program
  • Root-level pages (index, quickstart) were not included in any custom set
  • Indentation was inconsistent across custom set entries

Changes

  • Getting Started set: Added index and quickstart to the paths so root-level pages are covered
  • Support set: Replaced manual page listing with support-and-community/** glob, which catches the previously missing warp-preview-and-alpha-program page, automatically covers any future pages added under support-and-community/, and simplifies the config
  • Extended starlight-llms-txt patch: The upstream plugin only applies exclude to llms-small.txt. Our existing patch already extended it to llms-full.txt; this PR adds the same exclude pass to llms-custom.txt.ts so custom sets (e.g. the Support set) also skip pages that cause a stack overflow in hast-util-to-text. This was needed because the support-and-community/** glob now includes the ~25k-line open-source-licenses page.
  • Allowlisted /api for markdown-url-support: Added a markdown-url-support entry to known-exceptions.md/api is a custom Astro page (src/pages/api.astro), not a Starlight content page, so it intentionally has no .md variant.
  • Fixed indentation inconsistency in astro.config.mjs

Validation

  • Build succeeds locally: 315 pages, 313 markdown docs generated

Conversation: https://app.warp.dev/conversation/0f796c11-8a3f-4534-a70c-da06e9eb8cbc
Run: https://oz.warp.dev/runs/019e0699-c126-7d4d-8335-0eeef90547f3

This PR was generated with Oz.

- Add root pages (index, quickstart) to the Getting Started custom set
- Simplify Support custom set to use support-and-community/** glob
  instead of manually listing individual pages, which missed
  warp-preview-and-alpha-program
- Fix indentation inconsistency in customSets config

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 8, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 8, 2026 9:02pm

Request Review

@rachaelrenk rachaelrenk self-assigned this May 8, 2026
@rachaelrenk rachaelrenk marked this pull request as ready for review May 8, 2026 19:04
/api is a custom Astro page, not a Starlight doc page, so it
won't have a .md variant. This is expected and intentional.

Co-Authored-By: Oz <oz-agent@warp.dev>
The upstream plugin only applied the `exclude` option to llms-small.txt.
Our existing patch already extended it to llms-full.txt; this adds the
same exclude pass to llms-custom.txt.ts so custom sets (e.g. the Support
set) also skip pages that cause a stack overflow in hast-util-to-text.

Fixes the build failure caused by `support-and-community/**` including
the ~25k-line open-source-licenses page in the Support custom set.

Co-Authored-By: Oz <oz-agent@warp.dev>
@rachaelrenk rachaelrenk merged commit 5f7f277 into main May 8, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants