Docs site agent-readability (a14y) parity with the landing page#361
Merged
Conversation
Bring the MkDocs docs pages to a14y scorecard 0.2.0 parity with the
landing page (per-page checks the Astro landing passes but the docs
template never got). Five root-cause fixes:
A. overrides/main.html: inject OG tags, JSON-LD (TechArticle +
BreadcrumbList + dateModified), and a markdown alternate-link into
every content page's extrahead, guarded by {% if page %} so the
404 page's page=None does not abort the strict build.
B. mkdocs.yml + docs/requirements.txt: enable the
git-revision-date-localized plugin to feed JSON-LD dateModified and
the mirror last_updated.
C. hooks/enrich_md_mirrors.py: post-build hook that prepends YAML
frontmatter (title/description/doc_version/last_updated) and appends
a ## Sitemap section to the per-page .md mirrors llmstxt emits.
D. docs/site/reference/glossary.md + a site-wide footer link + nav entry.
E. pymdownx.highlight use_pygments: false so code renders with
language-* classes, plus a source sweep adding `text` to the five
bare opening fences across four published pages.
Proven with the external a14y oracle (CLI 0.4.21, scorecard 0.2.0):
mkdocs build --strict green, served site/, per-page score 58 -> target 90s.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
clkao
added a commit
that referenced
this pull request
Jun 13, 2026
clkao
added a commit
that referenced
this pull request
Jun 13, 2026
clkao
added a commit
that referenced
this pull request
Jun 13, 2026
clkao
added a commit
that referenced
this pull request
Jun 13, 2026
clkao
added a commit
that referenced
this pull request
Jun 13, 2026
…ackaged, docs-a14y shipped (#361), 9 Commander PRs landed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bring the docs pages to agent-readability parity with the landing — structured-metadata head, mirror frontmatter, a glossary, and language-tagged code on every page.
What changed
.mdmirror with YAML frontmatter + a## Sitemapsection via a post-build hooklanguage-*classes emit)Evidence
mkdocs build --strict: clean, no warningsev9