mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
rust/src/doc/index.md

82 lines
2.5 KiB
Markdown
Raw Normal View History

doc: Make sure all doc titles say 'Rust'. #12466
2014-08-01 16:31:22 -07:00
% Rust Documentation
First phase of migrating the wiki to the internal docs #11078
2013-12-22 20:21:45 -06:00
Strip the documentation index down to the essentials. The main documentation page is now www.rust-lang.org/documentation.html
2015-12-23 14:15:13 -08:00
<style>
nav {
display: none;
}
</style>
Revamp doc index Fixes #14972
2014-08-28 14:52:39 -04:00
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
Welcome to an overview of the documentation provided by the Rust project.
All of these projects are managed by the Docs Team; there are other
unofficial documentation resources as well!
Revamp doc index Fixes #14972
2014-08-28 14:52:39 -04:00
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
Many of these resources take the form of "books"; we collectively call these
"The Rust Bookshelf." Some are large, some are small.
doc: Remove mention of 30 minute intro
2015-05-08 13:18:04 -07:00
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
# Learn Rust
Revamp doc index Fixes #14972
2014-08-28 14:52:39 -04:00
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
If you'd like to learn Rust, this is the spot for you! All of these resources
assume that you have programmed before, but not in any specific language:
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## The Rust Programming Language
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
Affectionately nicknamed "the book," [The Rust Programming
Language](book/index.html) will give you an overview of the language from
first principles. You'll build a few projects along the way, and by the end,
you'll have a solid grasp of the language.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## Rust By Example
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
If reading multiple hundreds of pages about a language isn't your style, then
[Rust By Example](rust-by-example/index.html) has you covered. While the book talks about code with
a lot of words, RBE shows off a bunch of code, and keeps the talking to a
minimum. It also includes exercises!
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
# Use Rust
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
Fix typos found by codespell.
2018-08-19 15:30:23 +02:00
Once you've gotten familiar with the language, these resources can help you
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
when you're actually using it day-to-day.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## The Standard Library
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
Rust's standard library has [extensive API documentation](std/index.html),
with explanations of how to use various things, as well as example code for
accomplishing various tasks.
update doc index to link to the rustc book
2018-04-05 14:53:58 -04:00
## The Rustc Book
[The Rustc Book](rustc/index.html) describes the Rust compiler, `rustc`.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## The Cargo Book
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
[The Cargo Book](cargo/index.html) is a guide to Cargo, Rust's build tool and dependency manager.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## The Rustdoc Book
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
[The Rustdoc Book](rustdoc/index.html) describes our documentation tool, `rustdoc`.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## Extended Error Listing
doc: Add descriptions to links in the index These are the same descriptions as on the website.
2016-01-10 22:30:09 +00:00
review nits
2017-02-07 13:04:57 -05:00
Many of Rust's errors come with error codes, and you can request extended
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
diagnostics from the compiler on those errors. You can also [read them
here](error-index.html), if you prefer to read them that way.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
# Master Rust
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
Once you're quite familiar with the language, you may find these advanced
resources useful.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## The Reference
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
[The Reference](reference/index.html) is not a formal spec, but is more detailed and
comprehensive than the book.
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## The Rustonomicon
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
[The Rustonomicon](nomicon/index.html) is your guidebook to the dark arts of unsafe
Rust. It's also sometimes called "the 'nomicon."
Using X headings instead of 0.X #49739
2018-04-07 00:42:47 +05:30
## The Unstable Book
Reorder sections in doc/index.md
2015-09-06 15:25:01 +03:00
Re-write the documentation index The docs team has decided that we're framing resources in three ways: "learning Rust," "using Rust," "mastering Rust." This is a more useful split than "beginner/intermediate/advanced." As we add more resources in the future, we expect "using Rust" to grow. "the bookshelf" as a concept is great, but isn't really organized along these lines. As such, this reorganizes the docs along these lines.
2018-04-03 12:38:53 -04:00
[The Unstable Book](unstable-book/index.html) has documentation for unstable features.
Reference in New Issue Copy Permalink