-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: create setup documentation #18304
docs: create setup documentation #18304
Conversation
There are merge commits (commits with multiple parents) in your changes. We have a no merge policy so these commits will need to be removed for this pull request to be merged. You can start a rebase with the following commands:
The following commits are merge commits: |
f0c54fb
to
9ee29f4
Compare
docs/dev/setup.md
Outdated
You will also need Visual Studio Code and Visual Studio Code Insiders for this workflow. You can download and install Visual Studio Code [here](https://code.visualstudio.com/Download) and you can download and install Visual Studio Code Insiders [here](https://code.visualstudio.com/insiders/). | ||
|
||
You will also need to install the rust-analyzer extension for Visual Studio Code and Visual Studio Code Insiders. | ||
|
||
More information about Rust on Visual Studio Code can be found [here](https://code.visualstudio.com/docs/languages/rust) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vscode and/or vscode insiders isn't strictly requirement (unless you want to work on the vscode extension)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be fine to clarify that the setup is for vscode specifically though at the top (given the rest of this guide assumes it)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed vscode and vscode insders as prerequisites. I added some information at the top stating that this workflow guide assumes that the user is using vscode and vscode insiders for this workflow.
**Step 04**: Install the language server locally by running the following command: | ||
|
||
```sh | ||
cargo xtask install --server --code-bin code-insiders --dev-rel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cargo xtask install --server --dev-rel
no need to build the extension unless you use it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This workflow requires building a local installation of the extension. This would allow the user to view eprintln!
debug statements in the Rust Analyzer Language Server output.
a80d3c6
to
0719432
Compare
Created opinionated rust-analyzer workflow setup guide.