diff options
| author | Brian Anderson <banderson@mozilla.com> | 2015-12-23 14:15:13 -0800 |
|---|---|---|
| committer | Brian Anderson <banderson@mozilla.com> | 2015-12-23 14:15:13 -0800 |
| commit | 9e99a279078b399a92227a0dd043cfcdf85d14bb (patch) | |
| tree | 6c7442531f482ce76395ddd31a3d852ebb48a203 | |
| parent | 6c65cc1f8f817a6f580f1a6ca60c8259b80605ee (diff) | |
| download | rust-9e99a279078b399a92227a0dd043cfcdf85d14bb.tar.gz rust-9e99a279078b399a92227a0dd043cfcdf85d14bb.zip | |
Strip the documentation index down to the essentials.
The main documentation page is now www.rust-lang.org/documentation.html
| -rw-r--r-- | src/doc/index.md | 44 |
1 files changed, 13 insertions, 31 deletions
diff --git a/src/doc/index.md b/src/doc/index.md index 385a9b50421..fef9f1f369c 100644 --- a/src/doc/index.md +++ b/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) |
