8 width: calc(100% - 58px);
13 #search-but, #search-input {
15 border: 1px solid #ccc;
19 background-color: #fff;
21 #search-but:hover, #search-input:focus {
22 border-color: #55a9ff;
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!
33 Many of these resources take the form of "books"; we collectively call these
34 "The Rust Bookshelf." Some are large, some are small.
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:
41 ## The Rust Programming Language
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.
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!
57 [Rustlings](https://github.com/rust-lang/rustlings) guides you through downloading and setting up the Rust toolchain,
58 and teaches you the basics of reading and writing Rust syntax. It's an
59 alternative to Rust by Example that works with your own environment.
63 Once you've gotten familiar with the language, these resources can help you
64 when you're actually using it day-to-day.
66 ## The Standard Library
68 Rust's standard library has [extensive API documentation](std/index.html),
69 with explanations of how to use various things, as well as example code for
70 accomplishing various tasks.
73 <form action="std/index.html" method="get">
74 <input id="search-input" type="search" name="search"
75 placeholder="Search through the standard library"/>
76 <button id="search-but">Search</button>
82 [The Edition Guide](edition-guide/index.html) describes the Rust editions.
86 [The Rustc Book](rustc/index.html) describes the Rust compiler, `rustc`.
90 [The Cargo Book](cargo/index.html) is a guide to Cargo, Rust's build tool and dependency manager.
94 [The Rustdoc Book](rustdoc/index.html) describes our documentation tool, `rustdoc`.
98 [The Clippy Book](clippy/index.html) describes our static analyzer, Clippy.
100 ## Extended Error Listing
102 Many of Rust's errors come with error codes, and you can request extended
103 diagnostics from the compiler on those errors. You can also [read them
104 here](error-index.html), if you prefer to read them that way.
108 Once you're quite familiar with the language, you may find these advanced
113 [The Reference](reference/index.html) is not a formal spec, but is more detailed and
114 comprehensive than the book.
118 [The Rustonomicon](nomicon/index.html) is your guidebook to the dark arts of unsafe
119 Rust. It's also sometimes called "the 'nomicon."
123 [The Unstable Book](unstable-book/index.html) has documentation for unstable features.
125 ## The `rustc` Contribution Guide
127 [The `rustc` Guide](https://rustc-dev-guide.rust-lang.org/) documents how
128 the compiler works and how to contribute to it. This is useful if you want to build
129 or modify the Rust compiler from source (e.g. to target something non-standard).
133 When using Rust in specific domain areas, consider using the following resources tailored to each domain.
137 When developing for Bare Metal or Embedded Linux systems, you may find these resources maintained by the [Embedded Working Group] useful.
139 [Embedded Working Group]: https://github.com/rust-embedded
141 ### The Embedded Rust Book
143 [The Embedded Rust Book] is targeted at developers familiar with embedded development and familiar with Rust, but have not used Rust for embedded development.
145 [The Embedded Rust Book]: embedded-book/index.html
146 [Rust project]: https://www.rust-lang.org