ci: gate cargo doc warnings + fix broken intra-doc links (COW-1069)#28
Open
brunota20 wants to merge 1 commit into
Open
ci: gate cargo doc warnings + fix broken intra-doc links (COW-1069)#28brunota20 wants to merge 1 commit into
brunota20 wants to merge 1 commit into
Conversation
…nks (COW-1069) Locks the rustdoc discipline BLEU-844 (COW-1045) introduced. CI changes (.github/workflows/ci.yml): - New `docs:` job runs `cargo doc --workspace --no-deps` with `RUSTDOCFLAGS="-D warnings"`. Any rustdoc warning (missing docs, broken intra-doc link, unresolved code reference) fails CI. Source fixes surfaced by the new gate: - `crates/nexum-engine/src/bindings.rs:8`: drop `[crate::host::impls]` intra-doc link; `impls` is `mod` (private) so rustdoc cannot resolve it. Keep the prose reference unquoted. - `crates/nexum-engine/src/manifest/mod.rs:24`: `[load]` is ambiguous (sibling `fn load` + `mod load`). Disambiguate with `[mod@load]`. - `crates/nexum-engine/src/manifest/types.rs:4`: same fix for `[super::load]` -> `[mod@super::load]`. `#![warn(missing_docs)]` is already on `crates/shepherd-sdk/src/lib.rs` (line 80) and `crates/shepherd-sdk-test/src/lib.rs` (line 59), so the new CI step locks the existing baseline rather than introducing fresh churn. Verified locally: RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps -> clean Linear: COW-1069. Stacks on COW-1066 (CI matrix).
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.
What does this PR do?
Adds a CI `docs:` job running `cargo doc --workspace --no-deps` with `RUSTDOCFLAGS="-D warnings"`, so any rustdoc warning (missing docs, broken intra-doc link, unresolved code reference) fails CI. Fixes the 3 broken intra-doc links the new gate surfaced.
Why
Surfaced by the COW-1063 QA pass. BLEU-844 (COW-1045) said "no missing-docs warnings under `#![warn(missing_docs)]`" but nothing in CI enforces it. Without a gate, new `pub fn` items land without doc comments, renamed types break intra-doc links silently, and `[
SomeType]` references go stale.Changes
`#![warn(missing_docs)]` is already on `shepherd-sdk` (line 80) and `shepherd-sdk-test` (line 59), so the new CI step locks the existing baseline rather than introducing fresh churn.
Breaking changes
None.
Testing
AI assistance disclosure
AI Assistance: this change + description was produced by a Claude Code agent (Claude Opus 4.7 1M context). A human (Bruno) reviewed and is accountable for the result.
Linear: COW-1069. Stacks on #27 (COW-1066 CI matrix).