📝 docs: post-v1.0 audit — fix broken links, refresh stale refs, add Quay badge#69
Merged
Merged
Conversation
Post-v1.0.0 documentation audit cleanup: - 🐛 fix(docs): correct /docs-prefixed internal links that the basePath rewrite doubled to /docs/docs/* (404). cis-docker-benchmark, configuration, and presets now use bare /<page> links. - 🐛 fix(docs): point the CIS guide mTLS link at the real #mtls-client-selectors anchor instead of the non-existent #mtls. - 📝 docs(presets): list all 12 bundled presets in the frontmatter description (was stuck at the old count of 9). - 📝 docs(verification): use the <TAG> placeholder in the digest-pin example instead of the hardcoded 0.5.1 release tag. - 📝 docs(configuration): drop stale pre-release version references (0.5.x, pre-v0.7.0) in favor of version-agnostic wording.
The README advertises three registries (GHCR, Docker Hub, Quay.io) but the landing-page hero only linked two. Adds the Quay.io badge for parity.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
biggest-littlest
approved these changes
May 21, 2026
Member
biggest-littlest
left a comment
biggest-littlest
left a comment
There was a problem hiding this comment.
Post-v1.0 docs/website audit cleanup — broken-link fixes verified against built HTML, stale refs refreshed. LGTM.
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
2 participants
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.
Post-v1.0.0 accuracy pass over the docs site and marketing website, prompted by an audit of both surfaces against the shipped v1.0.0 feature set.
Docs (
docs/content/docs/)Broken internal links — links written as
/docs/<page>had thebasePath: "/docs"prefix applied again at build time, rendering as/docs/docs/<page>(404). Verified against built HTML before and after.cis-docker-benchmark.mdx—/docs/observability→/observability; mTLS link/docs/configuration#mtls→/configuration#mtls-client-selectors(the anchor was also wrong — the heading is "mTLS Client Selectors").configuration.mdx×2 —/docs/security#known-limitations→/security#known-limitations.presets.mdx—/docs/cis-docker-benchmark→/cis-docker-benchmark.Stale content
presets.mdx— frontmatterdescriptionlisted only 9 presets; updated to cover all 12 (the page body already documented them).verification.mdx— digest-pin example hardcoded the old0.5.1tag; switched to the<TAG>placeholder the rest of the page uses.configuration.mdx— dropped stale pre-release version references (0.5.x,pre-v0.7.0) in favor of version-agnostic wording.Website (
website/)Verification
/docspath.biomeclean on the website change; full pre-push suite (govulncheck, go-fuzz, knip, ts-test, build) green.