src/doc/index.md

   1 % Rust Documentation
   2
   3 <style>
   4 nav {
   5     display: none;
   6 }
   7 </style>
   8
   9 This page is an overview of the documentation included with your Rust install.
  10 Other unofficial documentation may exist elsewhere; for example, the [Rust
  11 Learning] project collects documentation from the community, and [Docs.rs]
  12 builds documentation for individual Rust packages.
  13
  14 # API Documentation
  15
  16 Rust provides a standard library with a number of features; [we host its
  17 documentation here][api].
  18
  19 # Extended Error Documentation
  20
  21 Many of Rust's errors come with error codes, and you can request extended
  22 diagnostics from the compiler on those errors. We also [have the text of those
  23 extended errors on the web][err], if you prefer to read them that way.
  24
  25 # The Rust Bookshelf
  26
  27 Rust provides a number of book-length sets of documentation, collectively
  28 nicknamed 'The Rust Bookshelf.'
  29
  30 * [The Rust Programming Language][book] teaches you how to program in Rust.
  31 * [The Unstable Book][unstable-book] has documentation for unstable features.
  32 * [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
  33 * [The Reference][ref] is not a formal spec, but is more detailed and comprehensive than the book.
  34 * [The Rustdoc Book][rustdoc-book] describes our documentation tool, `rustdoc`.
  35
  36 Initially, documentation lands in the Unstable Book, and then, as part of the
  37 stabilization process, is moved into the Book, Nomicon, or Reference.
  38
  39 Another few words about the reference: it is guaranteed to be accurate, but not
  40 complete. We have a policy that features must have documentation to be stabilized,
  41 but we did not always have this policy, and so there are some stable things that
  42 are not yet in the reference. We're working on back-filling things that landed
  43 before this policy was put into place. That work is being tracked
  44 [here][refchecklist].
  45
  46 [Rust Learning]: https://github.com/ctjhoa/rust-learning
  47 [Docs.rs]: https://docs.rs/
  48 [api]: std/index.html
  49 [ref]: reference/index.html
  50 [refchecklist]: https://github.com/rust-lang-nursery/reference/issues/9
  51 [err]: error-index.html
  52 [book]: book/index.html
  53 [nomicon]: nomicon/index.html
  54 [unstable-book]: unstable-book/index.html
  55 [rustdoc-book]: rustdoc/index.html
  56