Check documentation in CI
- Dominant language
- Rust
- Stars
- 4.8k
- Forks
- 565
- PR merge metrics
- No merged PRs in 30d
Description
@Patiga suggested in [#1144](https://github.com/dimforge/nalgebra/pull/1144#issuecomment-1236209175) that we check for broken links with `cargo doc` in CI. I looked through our CI config, and it looks like we are not running `cargo doc` at all. It seems like we should run `cargo doc` and fail the build if there are any substantial issues, such as broken links.
Contributor guide
No contributing guide indexed for this repository
Research direction
Inspect the repository's CI configuration and the context in pull request #1144, then determine how `cargo doc` is currently expected to behave. Add the documentation check so the CI build fails for substantial issues such as broken links, and verify that the CI configuration exercises it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100