Skip to content

Fix: drop the docs workflow's reference to a deleted hook - #1569

Merged
ChaoWao merged 1 commit into
hw-native-sys:mainfrom
ChaoWao:docs/drop-stale-griffe-filter-ref
Jul 29, 2026
Merged

Fix: drop the docs workflow's reference to a deleted hook#1569
ChaoWao merged 1 commit into
hw-native-sys:mainfrom
ChaoWao:docs/drop-stale-griffe-filter-ref

Conversation

@ChaoWao

@ChaoWao ChaoWao commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

.github/workflows/docs.yml told readers to see docs/_hooks/griffe_filter.py for "the one warning class that is deliberately not counted" by mkdocs build --strict.

That hook no longer exists — it was removed in #1546 once the type annotations it worked around landed. docs/_hooks/ now holds only repo_links.py, and mkdocs.yml registers 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.

-        # --strict fails on a dead intra-docs link, a page missing from nav, or a
-        # bad anchor. See docs/_hooks/griffe_filter.py for the one warning class
-        # that is deliberately not counted.
+        # --strict fails on a dead intra-docs link, a page missing from nav, or
+        # a bad anchor. No warning class is exempt.

Comment only — no behavior change.

Testing

  • grep -rIn griffe_filter . returns no remaining references
  • docs/_hooks/ contains only repo_links.py; mkdocs.yml hooks: lists only that file
  • The docs workflow's own build job exercises the line this comment describes

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>
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ac626399-0371-4995-8488-7e09e0372daa

📥 Commits

Reviewing files that changed from the base of the PR and between 5cbbeb4 and 4cd0e12.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml

📝 Walkthrough

Walkthrough

The documentation workflow comment now describes the failure modes enforced by mkdocs build --strict, removing the prior reference to warning handling in docs/_hooks/griffe_filter.py.

Changes

Documentation workflow

Layer / File(s) Summary
Strict build comment
.github/workflows/docs.yml
The comment documents failures for dead intra-documentation links, missing navigation pages, and invalid anchors.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Poem

A bunny checks the docs tonight,
No broken links escape its sight.
Bad anchors hop away,
Missing pages cannot stay—
Strict builds keep the path just right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the comment update removing a reference to a deleted docs hook.
Description check ✅ Passed The description matches the change and accurately explains the removed workflow comment reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ChaoWao
ChaoWao merged commit 8e89f01 into hw-native-sys:main Jul 29, 2026
18 checks passed
@ChaoWao
ChaoWao deleted the docs/drop-stale-griffe-filter-ref branch July 29, 2026 06:58
ChaoWao added a commit that referenced this pull request Jul 30, 2026
#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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant