Skip to content

Reorder sections in doc/index.md #28269

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 2 commits into from
Sep 6, 2015
Merged

Reorder sections in doc/index.md #28269

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
201bfbe
Reorder sections in doc/index.md
petrochenkov Sep 6, 2015
c34f350
Further tweaks to doc/index.md
petrochenkov Sep 6, 2015
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
36 changes: 19 additions & 17 deletions src/doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,30 @@ series of small examples.

[rbe]: http://rustbyexample.com/

# The Standard Library
# Language Reference

Rust does not have an exact specification yet, but an effort to describe as much of
the language in as much detail as possible is in [the reference](reference.html).

# Standard Library Reference

We have [API documentation for the entire standard
library](std/index.html). There's a list of crates on the left with more
specific sections, or you can use the search bar at the top to search for
something if you know its name.

# Tools

[Cargo](https://crates.io) is the Rust's package manager providing access to libraries
beyond the standard one, and its website contains lots of good documentation.

[`rustdoc`](book/documentation.html) is the Rust's documentation generator, a tool converting
annotated source code into HTML docs.

A bunch of non-official tools are available, such as [Racer](https://github.com/phildawes/racer)
(code completion engine), or [rustfmt](https://github.com/nrc/rustfmt) (source code formatter),
or text editor plugins.

# Community & Getting Help

If you need help with something, or just want to talk about Rust with others,
Expand Down Expand Up @@ -54,25 +71,10 @@ There is an active [subreddit](https://reddit.com/r/rust) with lots of
discussion and news about Rust.

There is also a [user forum](https://users.rust-lang.org), for all
user-oriented discussion, and a [developer
user-oriented discussion, and a [developer
forum](https://internals.rust-lang.org/), where the development of Rust
itself is discussed.

# Specification

Rust does not have an exact specification, but an effort to describe as much of
the language in as much detail as possible is in [the reference](reference.html).

# Tools

Rust is still a young language, so there isn't a ton of tooling yet, but the
tools we have are really nice.

[Cargo](https://crates.io) is Rust's package manager, and its website contains
lots of good documentation.

[`rustdoc`](book/documentation.html) is used to generate documentation for Rust code.

# FAQs

There are questions that are asked quite often, so we've made FAQs for them:
Expand Down