src/doc/index.md

   1 % Rust Documentation
   2
   3 Welcome to the Rust documentation! You can use the section headings above
   4 to jump to any particular section.
   5
   6 # Getting Started
   7
   8 If you haven't seen Rust at all yet, the first thing you should read is the
   9 introduction to [The Rust Programming Language](book/index.html). It'll give
  10 you a good idea of what Rust is like.
  11
  12 The book provides a lengthy explanation of Rust, its syntax, and its
  13 concepts. Upon completing the book, you'll be an intermediate Rust
  14 developer, and will have a good grasp of the fundamental ideas behind
  15 Rust.
  16
  17 [Rust By Example][rbe] teaches you Rust through a series of small
  18 examples.
  19
  20 [rbe]: http://rustbyexample.com/
  21
  22 # Language Reference
  23
  24 Rust does not have an exact specification yet, but an effort to describe as much of
  25 the language in as much detail as possible is in [the reference](reference.html).
  26
  27 # Standard Library Reference
  28
  29 We have [API documentation for the entire standard
  30 library](std/index.html). There's a list of crates on the left with more
  31 specific sections, or you can use the search bar at the top to search for
  32 something if you know its name.
  33
  34 # The Rustonomicon
  35
  36 [The Rustonomicon] is an entire book dedicated to explaining
  37 how to write `unsafe` Rust code. It is for advanced Rust programmers.
  38
  39 [The Rustonomicon]: nomicon/index.html
  40
  41 # Tools
  42
  43 [Cargo](http://doc.crates.io/index.html) is the Rust package manager providing access to libraries
  44 beyond the standard one, and its website contains lots of good documentation.
  45
  46 [`rustdoc`](book/documentation.html) is the Rust's documentation generator, a tool converting
  47 annotated source code into HTML docs.
  48
  49 # FAQs
  50
  51 There are questions that are asked quite often, so we've made FAQs for them:
  52
  53 * [Language Design FAQ](complement-design-faq.html)
  54 * [Language FAQ](complement-lang-faq.html)
  55 * [Project FAQ](complement-project-faq.html)
  56 * [How to submit a bug report](https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#bug-reports)
  57
  58 # The Error Index
  59
  60 If you encounter an error while compiling your code you may be able to look it
  61 up in the [Rust Compiler Error Index](error-index.html).
  62
  63 # Community Translations
  64
  65 Several projects have been started to translate the documentation into other
  66 languages:
  67
  68 - [Russian](https://github.com/kgv/rust_book_ru)
  69 - [Korean](https://github.com/rust-kr/doc.rust-kr.org)
  70 - [Chinese](https://github.com/KaiserY/rust-book-chinese)
  71 - [Spanish](https://goyox86.github.io/elpr)
  72 - [German](https://panicbit.github.io/rustbook-de)