-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Re-write the doc index page #39593
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.
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
Re-write the doc index page #39593
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,32 +6,44 @@ nav { | |
} | ||
</style> | ||
|
||
This is an index of the documentation included with the Rust | ||
compiler. For more comprehensive documentation see [the | ||
website](https://www.rust-lang.org). | ||
This page is an overview of the documentation included with your Rust install. | ||
Other unofficial documentation may exist elsewhere; for example, the [Rust | ||
Learning] project collects documentation from the community, and [Docs.rs] | ||
builds documentation for individual Rust packages. | ||
|
||
[**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. | ||
## API Documentation | ||
|
||
[**The Rust Reference**][ref]. While Rust does not have a | ||
specification, the reference tries to describe its working in | ||
detail. It is accurate, but not necessarily complete. | ||
Rust provides a standard library with a number of features; you can browse | ||
its documentation [here][api]. | ||
|
||
[**Standard Library API Reference**][api]. Documentation for the | ||
standard library. | ||
## Reference Documentation | ||
|
||
[**The Rustonomicon**][nomicon]. An entire book dedicated to | ||
explaining how to write unsafe Rust code. It is for advanced Rust | ||
programmers. | ||
Rust does not yet have a formal specification, but we have a reference document | ||
[ref][ref]. It is guaranteed to be accurate, but not complete. We now have a | ||
policy that all new features must be included in the reference before | ||
stabilization; however, we are still back-filling things that landed before | ||
then. That work is being tracked [here][38643]. | ||
|
||
[**Compiler Error Index**][err]. Extended explanations of | ||
the errors produced by the Rust compiler. | ||
## Extended Error Documentation | ||
|
||
[book]: book/index.html | ||
[ref]: reference.html | ||
All of Rust's errors code with error codes, and you can request extended | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this supposed to be "come with error codes"? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, thanks! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This isn't true though, there are errors which don't have error codes like |
||
diagnostics from the compiler on those errors. We also produce those | ||
diagnostics on the web [here][err], if you prefer to read them that way. | ||
|
||
## The Rust Bookshelf | ||
|
||
Rust provides a number of book-length sets of documentation, collectively | ||
nicknamed 'The Rust Bookshelf.' | ||
|
||
* [The Rust Programming Language][book] teaches you how to program in Rust. | ||
* [The Rustinomicon][nomicon] is your guidebook to the dark arts of unsafe Rust. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo Rustinomicon -> Rustonomicon |
||
|
||
[Rust Learning]: https://github.com/ctjhoa/rust-learning | ||
[Docs.rs]: https://docs.rs/ | ||
[api]: std/index.html | ||
[nomicon]: nomicon/index.html | ||
[ref]: reference.html | ||
[38643]: https://github.com/rust-lang/rust/issues/38643 | ||
[err]: error-index.html | ||
[book]: book/index.html | ||
[nomicon]: nomicon/index.html | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs.rs
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@onur, how should we refer to your project here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@steveklabnik I think this referral is enough, but it's up to you.