]> git.lizzy.rs Git - rust.git/commitdiff
Expand contributing "tip" in manual.adoc
authorLuke Taylor <tekul.hs@gmail.com>
Thu, 31 Dec 2020 16:41:32 +0000 (16:41 +0000)
committerLuke Taylor <tekul.hs@gmail.com>
Thu, 31 Dec 2020 22:23:06 +0000 (22:23 +0000)
- 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

docs/user/manual.adoc

index d4121b4011f4f1206fdcb188ab96f1edfe44568c..8ed7b041fa546ffb8f941a669658e60d4de6d9c2 100644 (file)
@@ -18,6 +18,9 @@ The LSP allows various code editors, like VS Code, Emacs or Vim, to implement se
 [.lead]
 To improve this document, send a pull request: +
 https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc]
+
+The 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.
+
 ====
 
 If 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.