Skip to content

Commit 9e99a27

Browse files
committed
Strip the documentation index down to the essentials.
The main documentation page is now www.rust-lang.org/documentation.html
1 parent 6c65cc1 commit 9e99a27

File tree

1 file changed

+13
-31
lines changed

1 file changed

+13
-31
lines changed

src/doc/index.md

+13-31
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,21 @@
11
% Rust Documentation
22

3-
Welcome to the Rust documentation! You can use the section headings above
4-
to jump to any particular section.
3+
<style>
4+
nav {
5+
display: none;
6+
}
7+
</style>
58

6-
# Getting Started
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).
712

8-
If you haven't seen Rust at all yet, the first thing you should read is the
9-
introduction to [The Rust Programming Language](book/index.html). It'll give
10-
you a good idea of what Rust is like.
13+
[**The Rust Programming Language**](book/index.html)
1114

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

17-
# Language Reference
17+
[**The Standard Library API Reference**](std/index.html)
1818

19-
Rust does not have an exact specification yet, but an effort to describe as much of
20-
the language in as much detail as possible is in [the reference](reference.html).
19+
[**The Rustonomicon**](nomicon/index.html)
2120

22-
# Standard Library Reference
23-
24-
We have [API documentation for the entire standard
25-
library](std/index.html). There's a list of crates on the left with more
26-
specific sections, or you can use the search bar at the top to search for
27-
something if you know its name.
28-
29-
# The Rustonomicon
30-
31-
[The Rustonomicon] is an entire book dedicated to explaining
32-
how to write `unsafe` Rust code. It is for advanced Rust programmers.
33-
34-
[The Rustonomicon]: nomicon/index.html
35-
36-
# The Error Index
37-
38-
If you encounter an error while compiling your code you may be able to look it
39-
up in the [Rust Compiler Error Index](error-index.html).
21+
[**The Compiler Error Index**](error-index.html)

0 commit comments

Comments
 (0)