aboutsummaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
authorLuke Taylor <[email protected]>2020-12-31 16:41:32 +0000
committerLuke Taylor <[email protected]>2020-12-31 22:23:06 +0000
commit6168a6f1ca22000158e2896348e54ba47d5d80db (patch)
tree3f64c1b7264f9ec3a7f47d37816d91a60a874178 /docs/user
parenta485c9b21dd927beee3dde5ac9ed56f61806cf55 (diff)
Expand contributing "tip" in manual.adoc
- Add link to asciidoc website - Explain how to create the generated adoc files from the source code - How to run asciidoctor to generate the manual
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/manual.adoc3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc
index d4121b401..8ed7b041f 100644
--- a/docs/user/manual.adoc
+++ b/docs/user/manual.adoc
@@ -18,6 +18,9 @@ The LSP allows various code editors, like VS Code, Emacs or Vim, to implement se
18[.lead] 18[.lead]
19To improve this document, send a pull request: + 19To improve this document, send a pull request: +
20https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] 20https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc]
21
22The manual is written in https://asciidoc.org[AsciiDoc] and includes some extra files which are generated from the source code. Run `cargo test` and `cargo xtask codegen` to create these and then `asciidoctor manual.adoc` to create an HTML copy.
23
21==== 24====
22 25
23If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum. 26If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum.