1
Fork 0

Strip the documentation index down to the essentials.

The main documentation page is now www.rust-lang.org/documentation.html
This commit is contained in:
Brian Anderson 2015-12-23 14:15:13 -08:00
parent 6c65cc1f8f
commit 9e99a27907

View file

@ -1,39 +1,21 @@
% Rust Documentation % Rust Documentation
Welcome to the Rust documentation! You can use the section headings above <style>
to jump to any particular section. nav {
display: none;
}
</style>
# Getting Started This is an index of the documentation included with the Rust
compiler. For more comprehensive documentation see [the
website](https://www.rust-lang.org).
If you haven't seen Rust at all yet, the first thing you should read is the [**The Rust Programming Language**](book/index.html)
introduction to [The Rust Programming Language](book/index.html). It'll give
you a good idea of what Rust is like.
The book provides a lengthy explanation of Rust, its syntax, and its [**The Rust Reference**](reference.html)
concepts. Upon completing the book, you'll be an intermediate Rust
developer, and will have a good grasp of the fundamental ideas behind
Rust.
# Language Reference [**The Standard Library API Reference**](std/index.html)
Rust does not have an exact specification yet, but an effort to describe as much of [**The Rustonomicon**](nomicon/index.html)
the language in as much detail as possible is in [the reference](reference.html).
# Standard Library Reference [**The Compiler Error Index**](error-index.html)
We have [API documentation for the entire standard
library](std/index.html). There's a list of crates on the left with more
specific sections, or you can use the search bar at the top to search for
something if you know its name.
# The Rustonomicon
[The Rustonomicon] is an entire book dedicated to explaining
how to write `unsafe` Rust code. It is for advanced Rust programmers.
[The Rustonomicon]: nomicon/index.html
# The Error Index
If you encounter an error while compiling your code you may be able to look it
up in the [Rust Compiler Error Index](error-index.html).