search

rust-analyzer / rust-analyzer.github.io

https://rust-analyzer.github.io/
87 stars 51 forks source link

Update emacs documentation, split into Eglot and LSP Mode #197

Closed meliache closed 1 year ago

meliache commented 1 year ago

Emacs has now two LSP clients, Eglot and LSP-Mode, where Eglot will soon be shipped with Emacs29. Both have rust-analyzer enabled by default in their latest versions and require no further setup other than just being installed and enabled. lsp-rust.el is not required anymore.

In instructions, give a one-liner how to enable each respective mode and for configuration link to exiting documentation to avoid this manual from getting deprecated again.

I couldn't built the documentation because of errors, it seems some dependencies are incompatible with the Ruby version 3 on Archlinux and I was too lazy to figure out how to setup up a project local ruby environment, as I never code in Ruby. Also I'm not experiences in asciidoc. I just tried to follow the style of other documentation and trusted the syntax highlighting, but it would be good if someone could check that the docs built nicely and the generated html is ok (no unexpected linebreaks, working syntax highlighting).

Resolves #196

lnicola commented 1 year ago

Thank you, but can you please file this against https://github.com/rust-lang/rust-analyzer?

meliache commented 1 year ago

Thanks, will do :+1:

I'm new to rust, which is why I was reading the setup documentation. Heard about rust-analyzer being merged into rust-lang, but thought the docs still are separate. I still land on this repo when I open https://rust-analyzer.github.io, which is linked in the latest rust-lang/rust-analyzer readme, and click on the github source icon on the bottom.

I'm not sure what the status of this repo is, but if it's supposed to not be used anymore, consider archiving and closing of new PR's. Anyway, I found the equivalent emacs section in https://github.com/rust-lang/rust-analyzer/blob/master/docs/user/manual.adoc#emacs, so I'll create my PR which fixes this against that.

lnicola commented 1 year ago

I still land on this repo when I open https://rust-analyzer.github.io/

Yes, but look at the note (next to the light bulb) at the top of https://rust-analyzer.github.io/manual.html. The manual lives in the main RA repo, and is copied here on each release.

This repo is still used for the rest of https://rust-analyzer.github.io/ (release notes and blog posts, mostly).