Run `cargo doc` in CI

Open Beginner friendly
#1,434 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
ci-cd

Research direction

Locate the repository's CI workflow and review how existing Rust checks are invoked. Add the requested cargo doc check, then confirm the workflow runs successfully and detects broken intra-doc links, including private-item documentation if that option is used.

Written by the indexing model from the issue text.

Description

documentation idiomaticity low priority testing

We should also run cargo doc and/or cargo doc --document-private-items in CI to make sure all the intra-doc links work.

Dominant language
Assembly
Stars
643
Forks
81
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from memorysafety/rav1d

All issues in memorysafety/rav1d

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.