ci: guard docs drift — mkdocs --strict as a PR check + link/anchor validation#59
Merged
Conversation
…lidation
Ports the docs CI drift guard: a parallel docs job running mkdocs --strict on
PRs, a validation block so broken links/anchors and orphaned pages fail the
build, and pinned docs deps.
Also fixes the two orphans the omitted_files check surfaced:
- adds the previously-orphaned index.md to the nav (as Overview);
- relocates docs/superpowers/{specs,plans} — superpowers spec/plan artifacts
mistakenly written into the mkdocs docs_dir (and published live) — into a
proper planning/changes/2026-06-29.01-python-3.11-3.12-support/ bundle, where
the repo convention keeps them. Those two pages 404 off the docs site after
deploy, which is correct: they were internal planning docs, not user docs.
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, and fixes the two pre-existing orphans the stricter validation surfaces.Guard:
mkdocs.yml—validation:block so broken internal links, broken#anchorfragments, and orphaned pages fail the--strictbuild..github/workflows/_checks.yml— paralleldocsjob runningjust docs-buildon PRs.docs/requirements.txt— pinmkdocs>=1.6,<2,mkdocs-material>=9,<10.Orphan fixes (required for
omitted_files):index.md(hero landing page) to nav as Overview — it already served at/; this only gives it a nav entry.docs/superpowers/{specs,plans}intoplanning/changes/2026-06-29.01-python-3.11-3.12-support/(design.md+plan.md). These were superpowers spec/plan artifacts written into the mkdocsdocs_dirand published live (both returned HTTP 200) — internal planning docs, not user docs. After deploy those two URLs 404, which is the intended correction. The plan file is agit mv(history preserved); the design gains the planning-conventionsummary:frontmatter.Verified: strict build passes (orphans gone),
just check-planningvalidates the new bundle, workflow YAML parses.🤖 Generated with Claude Code