Skip to content

afdocs: bump to 0.19, migrate config, refresh scorecard - #2740

Merged
chalin merged 10 commits into
google:mainfrom
chalin:chalin-m24-afdocs-bump-2026-0825
Aug 25, 2026
Merged

afdocs: bump to 0.19, migrate config, refresh scorecard#2740
chalin merged 10 commits into
google:mainfrom
chalin:chalin-m24-afdocs-bump-2026-0825

Conversation

@chalin

@chalin chalin commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator
  • Contributes to Improve support for AI-agent doc consumption #2614 (phase 1b).
  • Bumps afdocs to the latest cooldown-clean release; 0.20.0 (2 days old) can be retargeted at review. npm audit clean.
  • Migrates the config to the 0.17 renamed and split check IDs (old IDs now fail config load); coverage and parity checks stay disabled, rationale in the config comments.
  • Regenerates the scorecard under deterministic sampling: 100 (A+) -> 88 (B) is expected (wider page sample, upstream false-green fixes, and the re-enabled content-start check); further score work is follow-up under Improve support for AI-agent doc consumption #2614.
  • Fixes the scorecard embed on the agent-support page (was Markdown-rendered inside its fence) and adds a known-gaps caption.
  • Preview:

chalin added 4 commits August 25, 2026 09:01
…corecard

- llms-txt-directive -> llms-txt-directive-html + llms-txt-directive-md
- llms-txt-freshness -> llms-txt-coverage, run as informational (thresholds 0)
  since the site's llms.txt is deliberately curated; exclude test fixtures and
  taxonomy pages from the denominator
- re-enable content-start-position (measurement now strips script/style)
- re-enable markdown-content-parity with theme-chrome parityExclusions
- deterministic sampling for a reproducible committed scorecard
- regenerate the published scorecard (afdocs 0.19.0)
@chalin chalin added this to the 0.17.0 milestone Aug 25, 2026
@chalin
chalin marked this pull request as ready for review August 25, 2026 14:31
@chalin chalin changed the title afdocs: bump to 0.19, migrate config, re-enable curated checks afdocs: bump to 0.19, migrate config, refresh scorecard Aug 25, 2026
chalin added 6 commits August 25, 2026 12:36
- readfile without code=true Markdown-renders the artifact inside the
  fence (injected headings/paragraphs, visible on the live page); the
  code=true form emits it verbatim
- deterministic sampling stabilizes the sampled page set and scores, not
  the artifact bytes (timestamp changes per run)
- Hugo re-indents multiline shortcode output to the call site's list
  depth, and inside pre that renders as a 2-space prefix on every line;
  hoisting the details block out of the list removes it
- afdocs pads stdout with leading/trailing blank lines; the awk filter
  drops the edges (interior blank runs untouched)
- The theme's readfile shortcode has only an HTML template, so the
  markdown output format inherits Chroma markup; a site-local
  readfile.markdown.md variant emits the file raw, fenced when
  code=true, keeping the agent-facing variant presentation-free
- Review feedback: drop the unnecessary commas in the two new sentences
- Fence-content equality to the committed artifact is stronger than a
  byte golden of the page (also catches indent and edge-blank
  regressions) without churning on unrelated page edits
- Verified red-first: with the readfile.markdown.md variant removed,
  only the fence assertion fails; existing goldens stay green, so they
  never protected this contract
@chalin
chalin merged commit 59b42f6 into google:main Aug 25, 2026
18 checks passed
@chalin
chalin deleted the chalin-m24-afdocs-bump-2026-0825 branch August 25, 2026 19:52
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