25a7b2480e
But default to not to. I chose to have a more generic config name because maybe other assists could also use the same approach.
rust-analyzer documentation
The rust analyzer manual uses mdbook.
Quick start
To run the documentation site locally:
cargo install mdbook
cargo xtask codegen
cd docs/book
mdbook serve
# make changes to documentation files in doc/book/src
# ...
mdbook will rebuild the documentation as changes are made.
Making updates
While not required, installing the mdbook binary can be helfpul in order to see the changes. Start with the mdbook User Guide to familiarize yourself with the tool.
Generated documentation
Four sections are generated dynamically: assists, configuration, diagnostics and features. Their content is found in the generated.md files
of the respective book section, for example src/configuration_generated.md, and are included in the book via mdbook's
include functionality. Generated files can be rebuilt by running the various
test cases that generate them, or by simply running all of the rust-analyzer tests with cargo test and cargo xtask codegen.