Skip to content

doc: Add descriptions to links in the index #30814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 12, 2016
Merged

doc: Add descriptions to links in the index #30814

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions src/doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)