mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2025-09-28 11:20:54 +00:00
deda58e8f1
Split manual.adoc into markdown files, one for each chapter. For the parts of the manual that are generated from source code doc comments, update the comments to use markdown syntax and update the code generators to write to `generated.md` files. For the weekly release, stop copying the .adoc files to the `rust-analyzer/rust-analyzer.github.io` at release time. Instead, we'll sync the manual hourly from this repository. See https://github.com/rust-analyzer/rust-analyzer.github.io/pull/226 for the sync. This PR should be merged first, and that PR needs to be merged before the next weekly release. This change is based on #15795, but rebased and updated. I've also manually checked each page for markdown syntax issues and fixed any I encountered. Co-authored-by: Lukas Wirth <lukastw97@gmail.com> Co-authored-by: Josh Rotenberg <joshrotenberg@gmail.com>
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# rust-analyzer documentation
|
|
|
|
The rust analyzer manual uses [mdbook](https://rust-lang.github.io/mdBook/).
|
|
|
|
## Quick start
|
|
|
|
To run the documentation site locally:
|
|
|
|
```shell
|
|
cargo install mdbook
|
|
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](https://rust-lang.github.io/mdBook/guide/installation.html) 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](https://rust-lang.github.io/mdBook/format/mdbook.html#including-files) 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`.
|