Skip to content

Commit f0b719d

Browse files
committed
Rollup merge of rust-lang#29549 - brson:docidx, r=steveklabnik
I noticed the nomicon was not listed! I also removed links to racer and rustfmt since they were not *doc-specific* links, just links to tools, as well as pointed the cargo link directly at the docs. Removed all the community stuff. There are lots of other places to find this now, including the website. With pending website changes this page will continue to be pared back, reflecting only what's in-tree, not general Rust docs. r? @steveklabnik
2 parents 99093b7 + 5cc0a37 commit f0b719d

File tree

2 files changed

+12
-41
lines changed

2 files changed

+12
-41
lines changed

mk/docs.mk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@
2222
# L10N_LANGS are the languages for which the docs have been
2323
# translated.
2424
######################################################################
25-
DOCS := index intro tutorial \
25+
DOCS := index \
2626
complement-lang-faq complement-design-faq complement-project-faq \
2727
rustdoc reference grammar
2828

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

3434

3535
RUSTDOC_DEPS_reference := doc/full-toc.inc

src/doc/index.md

Lines changed: 10 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ concepts. Upon completing the book, you'll be an intermediate Rust
1414
developer, and will have a good grasp of the fundamental ideas behind
1515
Rust.
1616

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

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

@@ -32,49 +31,21 @@ library](std/index.html). There's a list of crates on the left with more
3231
specific sections, or you can use the search bar at the top to search for
3332
something if you know its name.
3433

34+
# The Rustonomicon
35+
36+
[The Rustonomicon] is an entire book dedicated to explaining
37+
how to write `unsafe` Rust code. It is for advanced Rust programmers.
38+
39+
[The Rustonomicon]: nomicon/index.html
40+
3541
# Tools
3642

37-
[Cargo](https://crates.io) is the Rust's package manager providing access to libraries
43+
[Cargo](http://doc.crates.io/index.html) is the Rust package manager providing access to libraries
3844
beyond the standard one, and its website contains lots of good documentation.
3945

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

43-
A bunch of non-official tools are available, such as [Racer](https://github.com/phildawes/racer)
44-
(code completion engine), or [rustfmt](https://github.com/nrc/rustfmt) (source code formatter),
45-
or text editor plugins.
46-
47-
# Community & Getting Help
48-
49-
If you need help with something, or just want to talk about Rust with others,
50-
there are a few places you can do that:
51-
52-
The Rust IRC channels on [irc.mozilla.org](irc://irc.mozilla.org/) are the
53-
fastest way to get help.
54-
[`#rust`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) is
55-
the general discussion channel, and you'll find people willing to help you with
56-
any questions you may have.
57-
58-
There are also three specialty channels:
59-
[`#rust-gamedev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev)
60-
and
61-
[`#rust-osdev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev)
62-
are for game development and operating system development, respectively.
63-
There's also
64-
[`#rust-internals`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals), which is for discussion of the development of Rust itself.
65-
66-
You can also get help on [Stack
67-
Overflow](https://stackoverflow.com/questions/tagged/rust). Searching for your
68-
problem might reveal someone who has asked it before!
69-
70-
There is an active [subreddit](https://reddit.com/r/rust) with lots of
71-
discussion and news about Rust.
72-
73-
There is also a [user forum](https://users.rust-lang.org), for all
74-
user-oriented discussion, and a [developer
75-
forum](https://internals.rust-lang.org/), where the development of Rust
76-
itself is discussed.
77-
7849
# FAQs
7950

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

0 commit comments

Comments
 (0)