diff options
| -rw-r--r-- | src/doc/index.md | 26 |
1 files changed, 21 insertions, 5 deletions
diff --git a/src/doc/index.md b/src/doc/index.md index fef9f1f369c..f8a1ec134d9 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -10,12 +10,28 @@ This is an index of the documentation included with the Rust compiler. For more comprehensive documentation see [the website](https://www.rust-lang.org). -[**The Rust Programming Language**](book/index.html) +[**The Rust Programming Language**][book]. Also known as "The Book", +The Rust Programming Language is the most comprehensive resource for +all topics related to Rust, and is the primary official document of +the language. -[**The Rust Reference**](reference.html) +[**The Rust Reference**][ref]. While Rust does not have a +specification, the reference tries to describe its working in +detail. It tends to be out of date. -[**The Standard Library API Reference**](std/index.html) +[**Standard Library API Reference**][api]. Documentation for the +standard library. -[**The Rustonomicon**](nomicon/index.html) +[**The Rustonomicon**][nomicon]. An entire book dedicated to +explaining how to write unsafe Rust code. It is for advanced Rust +programmers. + +[**Compiler Error Index**][err]. Extended explanations of +the errors produced by the Rust compiler. + +[book]: book/index.html +[ref]: reference.html +[api]: std/index.html +[nomicon]: nomicon/index.html +[err]: error-index.html -[**The Compiler Error Index**](error-index.html) |