src/doc/index.md

   1 % Rust Documentation
   2
   3 <style>
   4 nav {
   5     display: none;
   6 }
   7 #search-input {
   8     width: calc(100% - 58px);
   9 }
  10 #search-but {
  11     cursor: pointer;
  12 }
  13 #search-but, #search-input {
  14     padding: 4px;
  15     border: 1px solid #ccc;
  16     border-radius: 3px;
  17     outline: none;
  18     font-size: 0.7em;
  19     background-color: #fff;
  20 }
  21 #search-but:hover, #search-input:focus {
  22     border-color: #55a9ff;
  23 }
  24 h2 {
  25     font-size: 18px;
  26 }
  27 </style>
  28
  29 Welcome to an overview of the documentation provided by the Rust project.
  30 All of these projects are managed by the Docs Team; there are other
  31 unofficial documentation resources as well!
  32
  33 Many of these resources take the form of "books"; we collectively call these
  34 "The Rust Bookshelf." Some are large, some are small.
  35
  36 # Learn Rust
  37
  38 If you'd like to learn Rust, this is the spot for you! All of these resources
  39 assume that you have programmed before, but not in any specific language:
  40
  41 ## The Rust Programming Language
  42
  43 Affectionately nicknamed "the book," [The Rust Programming
  44 Language](book/index.html) will give you an overview of the language from
  45 first principles. You'll build a few projects along the way, and by the end,
  46 you'll have a solid grasp of the language.
  47
  48 ## Rust By Example
  49
  50 If reading multiple hundreds of pages about a language isn't your style, then
  51 [Rust By Example](rust-by-example/index.html) has you covered. While the book talks about code with
  52 a lot of words, RBE shows off a bunch of code, and keeps the talking to a
  53 minimum. It also includes exercises!
  54
  55 # Use Rust
  56
  57 Once you've gotten familiar with the language, these resources can help you
  58 when you're actually using it day-to-day.
  59
  60 ## The Standard Library
  61
  62 Rust's standard library has [extensive API documentation](std/index.html),
  63 with explanations of how to use various things, as well as example code for
  64 accomplishing various tasks.
  65
  66 <div>
  67   <form action="std/index.html" method="get">
  68     <input id="search-input" type="search" name="search"
  69            placeholder="Search through the standard library"/>
  70     <button id="search-but">Search</button>
  71   </form>
  72 </div>
  73
  74 ## The Edition Guide
  75
  76 [The Edition Guide](edition-guide/index.html) describes the Rust editions.
  77
  78 ## The Rustc Book
  79
  80 [The Rustc Book](rustc/index.html) describes the Rust compiler, `rustc`.
  81
  82 ## The Cargo Book
  83
  84 [The Cargo Book](cargo/index.html) is a guide to Cargo, Rust's build tool and dependency manager.
  85
  86 ## The Rustdoc Book
  87
  88 [The Rustdoc Book](rustdoc/index.html) describes our documentation tool, `rustdoc`.
  89
  90 ## Extended Error Listing
  91
  92 Many of Rust's errors come with error codes, and you can request extended
  93 diagnostics from the compiler on those errors. You can also [read them
  94 here](error-index.html), if you prefer to read them that way.
  95
  96 # Master Rust
  97
  98 Once you're quite familiar with the language, you may find these advanced
  99 resources useful.
 100
 101 ## The Reference
 102
 103 [The Reference](reference/index.html) is not a formal spec, but is more detailed and
 104 comprehensive than the book.
 105
 106 ## The Rustonomicon
 107
 108 [The Rustonomicon](nomicon/index.html) is your guidebook to the dark arts of unsafe
 109 Rust. It's also sometimes called "the 'nomicon."
 110
 111 ## The Unstable Book
 112
 113 [The Unstable Book](unstable-book/index.html) has documentation for unstable features.
 114
 115 ## The `rustc` Contribution Guide
 116
 117 [The `rustc` Guide](https://rust-lang.github.io/rustc-guide/) documents how
 118 the compiler works and how to contribute to it. This is useful if you want to build
 119 or modify the Rust compiler from source (e.g. to target something non-standard).
 120
 121 # Specialize Rust
 122
 123 When using Rust in specific domain areas, consider using the following resources tailored to each domain.
 124
 125 ## Embedded Systems
 126
 127 When developing for Bare Metal or Embedded Linux systems, you may find these resources maintained by the [Embedded Working Group] useful.
 128
 129 [Embedded Working Group]: https://github.com/rust-embedded
 130
 131 ### The Embedded Rust Book
 132
 133 [The Embedded Rust Book] is targeted at developers familiar with embedded development and familiar with Rust, but have not used Rust for embedded development.
 134
 135 [The Embedded Rust Book]: embedded-book/index.html