Difficulty: easy · Estimate: 1–2 hours
Right now make doc builds docs but doesn't fail the build on broken intra-doc links or warnings. Tightening this up keeps the public API documentation honest as the project grows. A common newcomer task with a real, lasting effect.
Where to look
What to do
- Update
make doc (or add make doc-check) to run:
RUSTDOCFLAGS="-D warnings -D rustdoc::broken_intra_doc_links" \
cargo doc --no-deps --workspace
- Add a CI job that runs this on PRs.
- Fix any broken links surfaced by enabling the lint (likely a small batch).
Done when
- CI fails on broken rustdoc links / warnings
- All currently-broken links are fixed
We'd love help with this — comment if you'd like to take it.
Difficulty: easy · Estimate: 1–2 hours
Right now
make docbuilds docs but doesn't fail the build on broken intra-doc links or warnings. Tightening this up keeps the public API documentation honest as the project grows. A common newcomer task with a real, lasting effect.Where to look
doctargetWhat to do
make doc(or addmake doc-check) to run:Done when
We'd love help with this — comment if you'd like to take it.