ci: guard docs drift — mkdocs --strict as a PR check + link/anchor validation#92
Merged
Conversation
…lidation Adds a parallel docs job running mkdocs --strict on PRs (matching the deploy build), a validation block so broken internal links/anchors and orphaned pages fail the build, and upper-bound pins on the docs toolchain. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Ports the docs CI drift guard (from
faststream-outbox) to this repo.mkdocs.yml— add avalidation:block (omitted_files/absolute_links/unrecognized_links/anchors: warn); under--strictthese become errors, so broken internal links, broken#anchorfragments, and orphaned pages fail the build..github/workflows/_checks.yml— new paralleldocsjob runningjust docs-build(same command as the deploy build), so docs breakage is caught on PRs instead of only at deploy.docs/requirements.txt— pinmkdocs>=1.6,<2,mkdocs-material>=9,<10for a reproducible, MkDocs-2.0-proof build.Verified: clean strict build passes; a broken anchor aborts the build (negative test).
🤖 Generated with Claude Code