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] was originally a community resource, but was then
  18 donated to the Rust project. As the name implies, it teaches you Rust through a
  19 series of small examples.
  20
  21 [rbe]: http://rustbyexample.com/
  22
  23 # Specification
  24
  25 Rust does not have an exact specification, but an effort to describe as much of
  26 the language in as much detail as possible is in [the reference](reference.html).
  27
  28 # The Standard Library
  29
  30 We have [API documentation for the entire standard
  31 library](std/index.html). There's a list of crates on the left with more
  32 specific sections, or you can use the search bar at the top to search for
  33 something if you know its name.
  34
  35 # Tools
  36
  37 Rust is still a young language, so there isn't a ton of tooling yet, but the
  38 tools we have are really nice.
  39
  40 [Cargo](https://crates.io) is Rust's package manager, and its website contains
  41 lots of good documentation.
  42
  43 [`rustdoc`](book/documentation.html) is used to generate documentation for Rust code.
  44
  45 # Community & Getting Help
  46
  47 If you need help with something, or just want to talk about Rust with others,
  48 there are a few places you can do that:
  49
  50 The Rust IRC channels on [irc.mozilla.org](irc://irc.mozilla.org/) are the
  51 fastest way to get help.
  52 [`#rust`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) is
  53 the general discussion channel, and you'll find people willing to help you with
  54 any questions you may have.
  55
  56 There are also three specialty channels:
  57 [`#rust-gamedev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev)
  58 and
  59 [`#rust-osdev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev)
  60 are for game development and operating system development, respectively.
  61 There's also
  62 [`#rust-internals`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals), which is for discussion of the development of Rust itself.
  63
  64 You can also get help on [Stack
  65 Overflow](https://stackoverflow.com/questions/tagged/rust). Searching for your
  66 problem might reveal someone who has asked it before!
  67
  68 There is an active [subreddit](https://reddit.com/r/rust) with lots of
  69 discussion and news about Rust.
  70
  71 There is also a [user forum](https://users.rust-lang.org), for all
  72 user-oriented discussion, and a [developer
  73 forum](https://internals.rust-lang.org/), where the development of Rust
  74 itself is discussed.
  75
  76 # FAQs
  77
  78 There are questions that are asked quite often, so we've made FAQs for them:
  79
  80 * [Language Design FAQ](complement-design-faq.html)
  81 * [Language FAQ](complement-lang-faq.html)
  82 * [Project FAQ](complement-project-faq.html)
  83 * [How to submit a bug report](https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#bug-reports)
  84
  85 # The Error Index
  86
  87 If you encounter an error while compiling your code you may be able to look it
  88 up in the [Rust Compiler Error Index](error-index.html).
  89
  90 # Community Translations
  91
  92 Several projects have been started to translate the documentation into other
  93 languages:
  94
  95 - [Russian](https://github.com/kgv/rust_book_ru)
  96 - [Korean](https://github.com/rust-kr/doc.rust-kr.org)
  97 - [Chinese](https://github.com/KaiserY/rust-book-chinese)
  98 - [Spanish](https://goyox86.github.io/elpr)