Skip to content

Commit

Permalink
Strip the documentation index down to the essentials.
Browse files Browse the repository at this point in the history
The main documentation page is now www.rust-lang.org/documentation.html
  • Loading branch information
brson committed Dec 23, 2015
1 parent 6c65cc1 commit 9e99a27
Showing 1 changed file with 13 additions and 31 deletions.
44 changes: 13 additions & 31 deletions src/doc/index.md
@@ -1,39 +1,21 @@
% Rust Documentation

Welcome to the Rust documentation! You can use the section headings above
to jump to any particular section.
<style>
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
introduction to [The Rust Programming Language](book/index.html). It'll give
you a good idea of what Rust is like.
[**The Rust Programming Language**](book/index.html)

The book provides a lengthy explanation of Rust, its syntax, and its
concepts. Upon completing the book, you'll be an intermediate Rust
developer, and will have a good grasp of the fundamental ideas behind
Rust.
[**The Rust Reference**](reference.html)

# 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 language in as much detail as possible is in [the reference](reference.html).
[**The Rustonomicon**](nomicon/index.html)

# Standard Library Reference

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).
[**The Compiler Error Index**](error-index.html)

0 comments on commit 9e99a27

Please sign in to comment.