src/doc/index.md

   1 % Rust Documentation
   2
   3 <style>
   4 nav {
   5     display: none;
   6 }
   7 </style>
   8
   9 This is an index of the documentation included with the Rust
  10 compiler. For more comprehensive documentation see [the
  11 website](https://www.rust-lang.org).
  12
  13 [**The Rust Programming Language**][book]. Also known as "The Book",
  14 The Rust Programming Language is the most comprehensive resource for
  15 all topics related to Rust, and is the primary official document of
  16 the language.
  17
  18 [**The Rust Reference**][ref]. While Rust does not have a
  19 specification, the reference tries to describe its working in
  20 detail. It is accurate, but not necessarily complete.
  21
  22 [**Standard Library API Reference**][api]. Documentation for the
  23 standard library.
  24
  25 [**The Rustonomicon**][nomicon]. An entire book dedicated to
  26 explaining how to write unsafe Rust code. It is for advanced Rust
  27 programmers.
  28
  29 [**Compiler Error Index**][err]. Extended explanations of
  30 the errors produced by the Rust compiler.
  31
  32 [book]: book/index.html
  33 [ref]: reference.html
  34 [api]: std/index.html
  35 [nomicon]: nomicon/index.html
  36 [err]: error-index.html
  37