Skip to content

AFDocs fixes: refresh known-exceptions allowlist for page-size and parity#319

Open
rachaelrenk wants to merge 2 commits into
mainfrom
afdocs-known-exceptions-2026-07-10
Open

AFDocs fixes: refresh known-exceptions allowlist for page-size and parity#319
rachaelrenk wants to merge 2 commits into
mainfrom
afdocs-known-exceptions-2026-07-10

Conversation

@rachaelrenk

Copy link
Copy Markdown
Contributor

Summary

Ran the AFDocs audit against docs.warp.dev. Score: 74/100 (C) — 23 checks, 15 pass, 5 fail, 1 warn, 2 skip.

All automatable AFDocs remediations are already in place: src/middleware.ts (content negotiation), the llms-directive in CustomHeader.astro, the directive in api.astro, public/.well-known/mcp.json, 100% .md URL support, and 100% llms.txt coverage. There were no new code remediations to apply.

The remaining failures/warning are all either allowlisted false positives / platform limits, or editorial page-size decisions the afdocs-fix skill explicitly does not auto-fix:

  • llms-txt-links-markdown (fail) → allowlisted: openapi.yaml/openapi.json false positive.
  • content-negotiation (fail) → allowlisted: Vercel serves static files before rewrites, so the middleware can't fire.
  • markdown-content-parity (fail, 1 page, ~3%) → allowlisted: Turndown escaping false positive.
  • page-size-markdown (fail, ~113K) → /changelog/2026/ (current-year changelog, grows until year-end).
  • page-size-html (fail, 396K HTML → 121K md) → /support-and-community/community/open-source-licenses/ (auto-generated) + other long reference pages.
  • llms-txt-directive-html (warn, 1/50) → sampling edge case; the directive is present globally.

Change

The only genuinely stale artifact was known-exceptions.md, which still described page-size as passing/borderline. Content growth now pushes several intentionally-long pages past the AFDocs 100K hard-fail threshold. This PR updates the allowlist so future audits classify them correctly:

  • open-source-licenses (~1.37M chars, auto-generated by release_updates)
  • changelog/2026 (~113–130K, current-year, split by year already)
  • privacy (~113K, legal)
  • Adds a sampling note (AFDocs samples ~49–50 of ~345 pages/run, so counts fluctuate)
  • Notes markdown-content-parity can surface as a single-page fail

No documentation content or site behavior changes.

Conversation: https://app.warp.dev/conversation/957cd3eb-debe-4e1f-8b91-9ae26f56fa6a
Run: https://oz.warp.dev/runs/019f4b0a-8ec5-7248-b604-f3eec782433d

This PR was generated with Oz.

…rity

The AFDocs audit (score 74/100, C) surfaced page-size-markdown and
page-size-html hard-fails driven by intentionally-long pages
(open-source-licenses auto-generated licenses, current-year changelog,
privacy legal text), plus a single-page markdown-content-parity fail
(Turndown escaping false positive). All automatable remediations
(llms.txt directive, .md URLs, content-negotiation middleware, mcp.json,
100% coverage) are already in place; the remaining failures are
allowlisted platform limits or editorial page-size decisions the
afdocs-fix skill explicitly does not auto-fix.

Updates the stale known-exceptions.md so future audits classify these
correctly.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jul 10, 2026
@vercel

vercel Bot commented Jul 10, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 10, 2026 3:56pm

Request Review

@rachaelrenk rachaelrenk marked this pull request as ready for review July 10, 2026 17:33
@oz-for-oss

oz-for-oss Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

@rachaelrenk

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overview

This PR refreshes the AFDocs known-exceptions reference to match current audit behavior for markdown-content parity and intentionally long page-size exceptions. It only updates internal review guidance for the AFDocs audit skill; it does not change published documentation content, site behavior, code, or configuration.

Concerns

  • No blocking concerns found.
  • No approved or repository spec context was available for implementation drift validation.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

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.

1 participant