Add more information to VSCode extenstion README #7837
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary
matklad
reviewed
Mar 1, 2021
| - [Embark Studios](https://embark-studios.com/) | ||
| - [freiheit.com](https://www.freiheit.com) | ||
|
|
||
|
|
There was a problem hiding this comment.
Let's add "Sponsor rust-analyzer on Open Collectieve" while we are at it (see the changelog for lings)
bjorn3
reviewed
Mar 1, 2021
editors/code/README.md
Outdated
| See https://rust-analyzer.github.io/ for more information. | ||
| ## Quick start | ||
|
|
||
| 1. Install [rustup] the rust toolchain |
There was a problem hiding this comment.
Suggested change
| 1. Install [rustup] the rust toolchain | |
| 1. Install [rustup] |
There was a problem hiding this comment.
Right, I copied that from the official rust extension, but just saying rustup is indeed nicer.
done
|
bors r+ |
lnicola
reviewed
Mar 2, 2021
|
|
||
| Features: | ||
| **Note** the project is in alpha status: it is already useful in practice, but can't be considered stable. |
There was a problem hiding this comment.
I think we should finally promote it to beta :-).
There was a problem hiding this comment.
Agree, with inner items support, it does feel like beta
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence.
This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP.
The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out.
I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary