From 6168a6f1ca22000158e2896348e54ba47d5d80db Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Thu, 31 Dec 2020 16:41:32 +0000 Subject: 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 --- docs/user/manual.adoc | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs') 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 [.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. -- cgit v1.2.3