rust-lang / rust-lang/rust-analyzer
Allow overriding `docs.rs` URLs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
This is a follow-up request to #12867.
Our organization has documentation hosted internally for our Rust workspace (built via cargo doc --workspace --document-private-items), so most users don't have docs built locally.
Right now, the autogenerated docs.rs URL is invalid for any of our internal crates, so it'd be very helpful to override the "base URL" or provide a format string to get to the docs for a crate.
Contributor guide
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
Review issue #12867 and locate the rust-analyzer code that generates the autogenerated docs.rs URL. Check how a configurable base URL or format string could support internally hosted documentation while preserving the current default for public crates. Done means internal crate links resolve correctly and existing docs.rs links remain unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100