RFC: ctrl-clicking `lean-manual` links in docstrings
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
Proposal
Since leanprover/lean4#7240 we have a lot of URLs of the form lean-manual://section/section-id in our docstrings. VS Code opens links in the browser when ctrl+clicking on them, but of course it does not know how to do that for lean-manual links.
I wonder if it would be possible for the VS Code extension to teach VS Code how to open these links so that they open the reference manual in the browser.
Impact
Add 👍 to issues you consider important. If others benefit from the changes in this proposal being added, please ask them to add 👍 to it.
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 inspecting the VS Code extension's link handling and how lean-manual URLs could map to the reference manual. Confirm the approach with maintainers, then verify that ctrl-clicking a lean-manual link opens the corresponding manual page in a browser.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vscode
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100