src/doc/index.md

   1 % Rust Documentation
   2
   3 <style>
   4 nav {
   5     display: none;
   6 }
   7 </style>
   8
   9 Welcome to an overview of the documentation provided by the Rust project.
  10 All of these projects are managed by the Docs Team; there are other
  11 unofficial documentation resources as well!
  12
  13 Many of these resources take the form of "books"; we collectively call these
  14 "The Rust Bookshelf." Some are large, some are small.
  15
  16 # Learn Rust
  17
  18 If you'd like to learn Rust, this is the spot for you! All of these resources
  19 assume that you have programmed before, but not in any specific language:
  20
  21 ## The Rust Programming Language
  22
  23 Affectionately nicknamed "the book," [The Rust Programming
  24 Language](book/index.html) will give you an overview of the language from
  25 first principles. You'll build a few projects along the way, and by the end,
  26 you'll have a solid grasp of the language.
  27
  28 ## Rust By Example
  29
  30 If reading multiple hundreds of pages about a language isn't your style, then
  31 [Rust By Example](rust-by-example/index.html) has you covered. While the book talks about code with
  32 a lot of words, RBE shows off a bunch of code, and keeps the talking to a
  33 minimum. It also includes exercises!
  34
  35 # Use Rust
  36
  37 Once you've gotten familiar with the language, these resources can help you
  38 when you're actually using it day-to-day.
  39
  40 ## The Standard Library
  41
  42 Rust's standard library has [extensive API documentation](std/index.html),
  43 with explanations of how to use various things, as well as example code for
  44 accomplishing various tasks.
  45
  46 <div>
  47   <form action="std/index.html" method="get">
  48     <input type="search" name="search"/>
  49     <button>Search</button>
  50   </form>
  51 </div>
  52
  53 ## The Rustc Book
  54
  55 [The Rustc Book](rustc/index.html) describes the Rust compiler, `rustc`.
  56
  57 ## The Cargo Book
  58
  59 [The Cargo Book](cargo/index.html) is a guide to Cargo, Rust's build tool and dependency manager.
  60
  61 ## The Rustdoc Book
  62
  63 [The Rustdoc Book](rustdoc/index.html) describes our documentation tool, `rustdoc`.
  64
  65 ## Extended Error Listing
  66
  67 Many of Rust's errors come with error codes, and you can request extended
  68 diagnostics from the compiler on those errors. You can also [read them
  69 here](error-index.html), if you prefer to read them that way.
  70
  71 # Master Rust
  72
  73 Once you're quite familiar with the language, you may find these advanced
  74 resources useful.
  75
  76 ## The Reference
  77
  78 [The Reference](reference/index.html) is not a formal spec, but is more detailed and
  79 comprehensive than the book.
  80
  81 ## The Rustonomicon
  82
  83 [The Rustonomicon](nomicon/index.html) is your guidebook to the dark arts of unsafe
  84 Rust. It's also sometimes called "the 'nomicon."
  85
  86 ## The Unstable Book
  87
  88 [The Unstable Book](unstable-book/index.html) has documentation for unstable features.