Relative links from a crate's README.md are incorrect on docs.rs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
(Advanced apologies if this is a duplicate. I've detected this with cargo-release. I've searched for cargo-release in https://github.com/rust-lang/docs.rs/issues/ and couldn't find any.)
https://github.com/crate-ci/cargo-release -> README.md contains two relative references: [reference](docs/reference.md) and [FAQ](docs/faq.md). Both files do exist.
However, https://docs.rs/crate/cargo-release/latest links to https://docs.rs/crate/cargo-release/docs/reference.md and https://docs.rs/crate/cargo-release/docs/faq.md - and both links fail (The requested version does not exist).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the broken links from cargo-release's README.md on its docs.rs crate page, using the references docs/reference.md and docs/faq.md. Trace how docs.rs renders relative README links, then verify that both references resolve to the corresponding crate documentation locations without the invalid version path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100