Skip to content

Commit 8dd7eab

Browse files
committed
Rollup merge of #30814 - brson:docidx, r=steveklabnik
These are the same descriptions as on the website. re https://www.reddit.com/r/rust/comments/409nlo/i_just_noticed_the_docs_nightly_all_docs_got_more/cytc4ab r? @steveklabnik
2 parents 0b8370c + bcf20a7 commit 8dd7eab

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

src/doc/index.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,28 @@ This is an index of the documentation included with the Rust
1010
compiler. For more comprehensive documentation see [the
1111
website](https://www.rust-lang.org).
1212

13-
[**The Rust Programming Language**](book/index.html)
13+
[**The Rust Programming Language**][book]. Also known as "The Book",
14+
The Rust Programming Language is the most comprehensive resource for
15+
all topics related to Rust, and is the primary official document of
16+
the language.
1417

15-
[**The Rust Reference**](reference.html)
18+
[**The Rust Reference**][ref]. While Rust does not have a
19+
specification, the reference tries to describe its working in
20+
detail. It tends to be out of date.
1621

17-
[**The Standard Library API Reference**](std/index.html)
22+
[**Standard Library API Reference**][api]. Documentation for the
23+
standard library.
1824

19-
[**The Rustonomicon**](nomicon/index.html)
25+
[**The Rustonomicon**][nomicon]. An entire book dedicated to
26+
explaining how to write unsafe Rust code. It is for advanced Rust
27+
programmers.
28+
29+
[**Compiler Error Index**][err]. Extended explanations of
30+
the errors produced by the Rust compiler.
31+
32+
[book]: book/index.html
33+
[ref]: reference.html
34+
[api]: std/index.html
35+
[nomicon]: nomicon/index.html
36+
[err]: error-index.html
2037

21-
[**The Compiler Error Index**](error-index.html)

0 commit comments

Comments
 (0)