Fix: drop the docs workflow's reference to a deleted hook - #1569
Conversation
The `mkdocs build --strict` step pointed readers at `docs/_hooks/griffe_filter.py` for "the one warning class that is deliberately not counted". That hook was removed once the annotations it worked around landed, so `docs/_hooks/` holds only `repo_links.py` and `mkdocs.yml` registers only that one. The strict build has no exemption left; the comment now says so. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation workflow comment now describes the failure modes enforced by ChangesDocumentation workflow
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
#1581) `validation.links.anchors` defaults to `info`, which `--strict` ignores. A link to a heading that was renamed or never existed therefore built clean and 404'd in the reader's browser. Six were live: | Link | Target | | ---- | ------ | | `ci.md#sanitizer-sim` (3 sites) | never existed; the heading is `Nightly sanitizer sweep` | | `orchestrator.md#5-ring-slot--per-scope-heap-allocator` | doubled hyphen | | `l0-swimlane-profiling.md#34-viewing--insight-vs-perfetto` | doubled hyphen | | `l0-swimlane-profiling.md#72---set-arg-floor-...` | tripled hyphen | | `args-dump.md#8-faq--debug-guide` | doubled hyphen | The last four were not typos. GitHub and MkDocs slugify differently: a heading like `## 8. FAQ / Debug Guide` drops the `/` and leaves two spaces, which GitHub renders as `8-faq--debug-guide` and MkDocs collapses to `8-faq-debug-guide`. Those links were correct in the GitHub view and broken on the published site. Repointing them would only have moved the breakage, so the four headings lose the punctuation that splits them instead — `+` to `and`, an em dash to a colon, `/` to `and`, and a leading `--set-arg` out of the heading text. Both slug dialects now agree, and every referring link is updated. With the six fixed, `anchors: warn` is enabled. Verified it bites: pointing `sanitizers.md` at `ci.md#does-not-exist` fails the build with exit 1. This also makes the comment on the build step in `.github/workflows/docs.yml` true. It has claimed since #1569 that `--strict` fails on a bad anchor; it did not. Still reported at INFO and not addressed here: five links to directories with no index page (`hardware/`, `troubleshooting/`, `remote-l3-worker-design/`, `troubleshooting/device-error-codes/`). They resolve in the GitHub view and 404 on the site; fixing them means adding index pages, not editing links.
Summary
.github/workflows/docs.ymltold readers to seedocs/_hooks/griffe_filter.pyfor "the one warning class that is deliberately not counted" bymkdocs build --strict.That hook no longer exists — it was removed in #1546 once the type annotations it worked around landed.
docs/_hooks/now holds onlyrepo_links.py, andmkdocs.ymlregisters only that one. The strict build has no exempt warning class at all, so the comment both pointed at a missing file and understated the guarantee.Comment only — no behavior change.
Testing
grep -rIn griffe_filter .returns no remaining referencesdocs/_hooks/contains onlyrepo_links.py;mkdocs.ymlhooks:lists only that filedocsworkflow's own build job exercises the line this comment describes