Rust analyzer integration
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 18.3k
- Forks
- 4.1k
- Avg merge
- 14m
- Merged PRs (30d)
- 1
Description
Hi! I made a mdbook plugin for rust analyzer, which adds inlay hints and hover to code snippets. You can see the book rendered with this plugin.
In my opinion, these features helps reader to have a better sense of what is going on and can solve confusions in some cases.
Current version is at the proof of concept level, but if you are interested, I can fix its problems and make it ready.
If you decide to add this to the book, to avoid confusion, I suggest disabling inlay hints for beginning parts and at some point, adding a paragraph like this:
There is a devtool for rust called rust analyzer, which, among other features, provide hover information and inlay hints in your development environment...... These features help better understanding codes so they are enabled in the book and you will see them in next codes....... Types are hard to write, but good to read, so type inference + inlay hints is win-win.
cc @matklad and rust analyzer guys.
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 reviewing the linked rendered book and the proof-of-concept plugin described in the issue. Clarify whether the book should adopt the integration and which sections should enable inlay hints; done would require an agreed production-ready plugin and documented integration scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100