Skip to content

Various cleanups to doc index #29549

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 7 commits into from
Nov 17, 2015
Merged

Various cleanups to doc index #29549

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ad900da
mk: Move some old docs to the deprecated list
brson Nov 3, 2015
be9afcc
doc: Remove irrelevant info about rbe
brson Nov 3, 2015
f553292
doc: Remove non-documentation tool links
brson Nov 3, 2015
53fad90
doc: Remove community info
brson Nov 3, 2015
6ca0fa9
doc: Add the Rustonomicon
brson Nov 3, 2015
48c170d
doc: Link to cargo docs, not just crates.io
brson Nov 3, 2015
5cc0a37
Minor tweaks to doc index
brson Nov 16, 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
4 changes: 2 additions & 2 deletions mk/docs.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@
# L10N_LANGS are the languages for which the docs have been
# translated.
######################################################################
DOCS := index intro tutorial \
DOCS := index \
complement-lang-faq complement-design-faq complement-project-faq \
rustdoc reference grammar

# Legacy guides, preserved for a while to reduce the number of 404s
DOCS += guide-crates guide-error-handling guide-ffi guide-macros guide \
guide-ownership guide-plugins guide-pointers guide-strings guide-tasks \
guide-testing
guide-testing tutorial intro


RUSTDOC_DEPS_reference := doc/full-toc.inc
Expand Down
49 changes: 10 additions & 39 deletions src/doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ concepts. Upon completing the book, you'll be an intermediate Rust
developer, and will have a good grasp of the fundamental ideas behind
Rust.

[Rust By Example][rbe] was originally a community resource, but was then
donated to the Rust project. As the name implies, it teaches you Rust through a
series of small examples.
[Rust By Example][rbe] teaches you Rust through a series of small
examples.

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

Expand All @@ -32,49 +31,21 @@ 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.

# The Rustonomicon

[The Rustonomicon] is an entire book dedicated dedicated to explaining
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"dedicated" is duplicated.

how to write `unsafe` Rust code. It is for advanced Rust programmers.

[The Rustonomicon]: nomicon/index.html

# Tools

[Cargo](https://crates.io) is the Rust's package manager providing access to libraries
[Cargo](http://doc.crates.io/index.html) is the Rust's package manager providing access to libraries
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this can also just say "Rust's" instead of "the Rust's".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or "the Rust package manager"... sounds better to me.

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,
there are a few places you can do that:

The Rust IRC channels on [irc.mozilla.org](irc://irc.mozilla.org/) are the
fastest way to get help.
[`#rust`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) is
the general discussion channel, and you'll find people willing to help you with
any questions you may have.

There are also three specialty channels:
[`#rust-gamedev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev)
and
[`#rust-osdev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev)
are for game development and operating system development, respectively.
There's also
[`#rust-internals`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals), which is for discussion of the development of Rust itself.

You can also get help on [Stack
Overflow](https://stackoverflow.com/questions/tagged/rust). Searching for your
problem might reveal someone who has asked it before!

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
forum](https://internals.rust-lang.org/), where the development of Rust
itself is discussed.

# FAQs

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