rust-analyzer/docs/book/src
2025-08-01 10:48:54 -05:00
..
contributing Fix more docs 2025-08-01 10:48:54 -05:00
assists.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
configuration.md Update configuration.md 2025-02-20 03:21:45 +01:00
configuration_generated.md Update documentation for overrideCommand config options 2025-08-01 10:48:54 -05:00
diagnostics.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
editor_features.md Update editor_features.md 2025-02-20 17:05:18 +01:00
faq.md Add troubleshooting FAQ to the book 2025-06-23 21:16:21 +03:00
features.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
installation.md manual: Separate out installation and configuration pages 2025-02-12 10:21:09 -08:00
non_cargo_based_projects.md Document sysroot_project field in rust-project.json 2025-06-23 10:43:45 +01:00
other_editors.md Remove rust-analyzer.vs from other editors 2025-05-22 07:37:25 +00:00
privacy.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
README.md doc: error url 2025-02-09 17:49:26 +08:00
rust_analyzer_binary.md manual: Separate out installation and configuration pages 2025-02-12 10:21:09 -08:00
security.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
SUMMARY.md Add troubleshooting FAQ to the book 2025-06-23 21:16:21 +03:00
troubleshooting.md Fix link in the book 2025-06-25 06:30:16 +03:00
vs_code.md manual: Separate out installation and configuration pages 2025-02-12 10:21:09 -08:00

rust-analyzer

At its core, rust-analyzer is a library for semantic analysis of Rust code as it changes over time. This manual focuses on a specific usage of the library -- running it as part of a server that implements the Language Server Protocol (LSP). The LSP allows various code editors, like VS Code, Emacs or Vim, to implement semantic features like completion or goto definition by talking to an external language server process.

To improve this document, send a pull request: https://github.com/rust-lang/rust-analyzer

The manual is written in markdown and includes some extra files which are generated from the source code. Run cargo test and cargo xtask codegen to create these.

If you have questions about using rust-analyzer, please ask them in the "IDEs and Editors" topic of Rust users forum.