rust-lang / rust-lang/rust-analyzer
Add support for resolving documentation links to local documentation
Open
Nobody has claimed this yet.
A-doc-comments
C-enhancement
S-actionable
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
This will consist of:
- Add the actual logic for resolving links (and bare definitions for the open docs command) to local documentation
- Add a clientside trampoline so that
file://URLs can be opened with a browser instead of in the editor
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
Start by tracing the documentation-link resolution and the open docs command, then review the VS Code command-URI guidance for the clientside trampoline. Done means links resolve to local documentation and file:// URLs open with a browser instead of the editor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, vscode
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100