Broken relative link to source file in README
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
https://docs.rs/crate/ripgrep/11.0.2
Relative link User Guide points to https://docs.rs/crate/ripgrep/GUIDE.md which does not exist (404).
Instead, it should either points to source/$file with url replacement (https://github.com/rust-lang/docs.rs/blob/32074e792046a7c41c716f592c692383528515b5/src/web/mod.rs#L387) or $file gets redirected to source/$file (somewhere near https://github.com/rust-lang/docs.rs/blob/32074e792046a7c41c716f592c692383528515b5/src/web/mod.rs#L226-L232).
So far, I have only seen this bug affecting README.
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
Start in src/web/mod.rs around lines 226-232 and 387, then reproduce the broken README User Guide link at docs.rs/crate/ripgrep/11.0.2. Decide whether URL replacement or redirecting $file is consistent with the existing routing; done means the relative README link resolves to the source file instead of returning 404.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- web-dev
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100