docs(rustdoc): quiet warning links#8191
Conversation
singlerider
left a comment
There was a problem hiding this comment.
I checked each converted link against item visibility and the failing check.
🟢 What looks good: only the unresolvable links were downgraded
load_skills_from_directory is pub, so its intra-doc link resolves and you correctly left it as a link. load_open_skills_from_directory is a private fn, so an intra-doc link to it warns under rustdoc; converting it to a plain code span is the right fix. Same for OptionSpec (private at that doc site) and [channels], which is a config section name and never a Rust item, so the bracket link was bogus from the start. The discrimination here is exactly correct: keep the one link that resolves, downgrade the three that cannot.
🟢 What looks good: the only red check is a stale title lint, not the code
The failing main job is the PR-title Conventional Commits check, and it ran against the old title docs: quiet rustdoc warning links with no scope. The title now reads docs(rustdoc): quiet warning links, which satisfies the type(scope): description rule, so a re-run clears it. The diff itself is docs-only and sound.
Approving on the corrected title; a CI re-run will turn the title check green.
WareWolf-MoonWall
left a comment
There was a problem hiding this comment.
Reviewed head cf0fb0e. I checked the three changed doc sites against local source, confirmed item visibility for each modified link, and verified the CI check suite.
🟢 What looks good — discrimination between resolvable and private items is exact
The diff changes exactly three intra-doc links and leaves one alone. Cross-checking against local source confirms the discrimination is correct:
load_open_skills_from_directory— confirmedfn(nopub) incrates/zeroclaw-runtime/src/skills/mod.rs. An intra-doc link to a private item at that doc site warns underRUSTDOCFLAGS=-Dwarnings; converting to a plain code span is the right call.OptionSpec— private at thezeroclaw-channelsdiscord types doc site; converting to a code span is correct.[channels]— a TOML section name, not a Rust item. A bracket-link to it was always a false intra-doc reference; converting to a backtick inline is the right fix.load_skills_from_directory— confirmedpub fnin the same module. The intra-doc link resolves; leaving it as a link is correct and is what the diff does.
Three items fixed, one left as a live link: the discrimination is exact.
🟢 What looks good — scope is strictly docs-only
The diff is +3 -3 across cache.rs, sections.rs, and discord/types.rs. No runtime behaviour, config parsing, CLI surface, or generated-docs pipeline logic is touched. The blast radius is zero outside the rustdoc output.
🟢 What looks good — CI is clean
All 18 CI jobs pass on this commit. The PR view briefly showed one failing check (the PR-title Conventional Commits job from the old title docs: quiet rustdoc warning links); the title has since been corrected to docs(rustdoc): quiet warning links, and the main job now shows pass. The diff itself has been clean throughout.
🟢 What looks good — validation evidence is proportionate
The author ran RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps -p zeroclaw-config -p zeroclaw-runtime -p zeroclaw-channels and confirmed zero warnings on the three touched doc surfaces. That is the right targeted command for a docs-only fix. Skipping the full format/clippy/test battery for a doc-comment-only patch is explicitly justified by the PR template guidance and is appropriate here.
Related zeroclaw-labs#7269. - Convert the remaining unresolvable rustdoc link text in the touched surfaces to code spans. - Keep this slice limited to rustdoc warning cleanup, leaving mdBook/localization warnings for follow-up work. Validation: - GitHub CI passed for head d9f8e73.
Summary
master[channels]config section mention as code so rustdoc does not resolve it as an intra-doc link.bug,size: XS,risk: low,channel,config,runtime,skillsValidation Evidence (required)
Security & Privacy Impact (required)
Yes, describe the risk and mitigation: None.Compatibility (required)
NoorYesto either: No upgrade steps required.Rollback (required for
risk: mediumandrisk: high)Low-risk PR. Roll back with
git revert cf0fb0e9194ec6de72c80af8b5f69979bb845868if needed.