Skip to content

Commit 83595fa

Browse files
authored
Rollup merge of #39593 - steveklabnik:bookshelf-landing-page, r=frewsxcv
Re-write the doc index page Clarify and reorganize. Add the section for the bookshelf. More to come here in the near future! Part of #39588
2 parents 1531071 + 78dd2ec commit 83595fa

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

src/doc/index.md

+32-20
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,44 @@ nav {
66
}
77
</style>
88

9-
This is an index of the documentation included with the Rust
10-
compiler. For more comprehensive documentation see [the
11-
website](https://www.rust-lang.org).
9+
This page is an overview of the documentation included with your Rust install.
10+
Other unofficial documentation may exist elsewhere; for example, the [Rust
11+
Learning] project collects documentation from the community, and [Docs.rs]
12+
builds documentation for individual Rust packages.
1213

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.
14+
## API Documentation
1715

18-
[**The Rust Reference**][ref]. While Rust does not have a
19-
specification, the reference tries to describe its working in
20-
detail. It is accurate, but not necessarily complete.
16+
Rust provides a standard library with a number of features; [we host its
17+
documentation here][api].
2118

22-
[**Standard Library API Reference**][api]. Documentation for the
23-
standard library.
19+
## Reference Documentation
2420

25-
[**The Rustonomicon**][nomicon]. An entire book dedicated to
26-
explaining how to write unsafe Rust code. It is for advanced Rust
27-
programmers.
21+
Rust does not yet have a formal specification, but we have [a reference document
22+
][ref]. It is guaranteed to be accurate, but not complete. We now have a
23+
policy that all new features must be included in the reference before
24+
stabilization; however, we are still back-filling things that landed before
25+
then. That work is being tracked [here][38643].
2826

29-
[**Compiler Error Index**][err]. Extended explanations of
30-
the errors produced by the Rust compiler.
27+
## Extended Error Documentation
3128

32-
[book]: book/index.html
33-
[ref]: reference.html
29+
Many of Rust's errors come with error codes, and you can request extended
30+
diagnostics from the compiler on those errors. We also [have the text of those
31+
extended errors on the web][err], if you prefer to read them that way.
32+
33+
## The Rust Bookshelf
34+
35+
Rust provides a number of book-length sets of documentation, collectively
36+
nicknamed 'The Rust Bookshelf.'
37+
38+
* [The Rust Programming Language][book] teaches you how to program in Rust.
39+
* [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
40+
41+
[Rust Learning]: https://github.com/ctjhoa/rust-learning
42+
[Docs.rs]: https://docs.rs/
3443
[api]: std/index.html
35-
[nomicon]: nomicon/index.html
44+
[ref]: reference.html
45+
[38643]: https://github.com/rust-lang/rust/issues/38643
3646
[err]: error-index.html
47+
[book]: book/index.html
48+
[nomicon]: nomicon/index.html
3749

0 commit comments

Comments
 (0)