From ad900dae925b11c7999fc5dbb2dc7eba3dd274b4 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Tue, 3 Nov 2015 12:46:06 -0800 Subject: [PATCH 1/7] mk: Move some old docs to the deprecated list --- mk/docs.mk | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mk/docs.mk b/mk/docs.mk index 644fbde323c..b0872c88c14 100644 --- a/mk/docs.mk +++ b/mk/docs.mk @@ -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 From be9afcca8928a5fc484efe06f93d7256c95c00b6 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Tue, 3 Nov 2015 12:47:57 -0800 Subject: [PATCH 2/7] doc: Remove irrelevant info about rbe --- src/doc/index.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/doc/index.md b/src/doc/index.md index 992b6eef5e8..70d3e9781aa 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -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/ From f553292cf69afcaf9975bb0226e4167caa4eebd4 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Tue, 3 Nov 2015 12:48:47 -0800 Subject: [PATCH 3/7] doc: Remove non-documentation tool links --- src/doc/index.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/doc/index.md b/src/doc/index.md index 70d3e9781aa..e60468e483f 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -39,10 +39,6 @@ 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, From 53fad90608491474cfde1604ccb54dbde68cea40 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Tue, 3 Nov 2015 12:49:21 -0800 Subject: [PATCH 4/7] doc: Remove community info --- src/doc/index.md | 31 ------------------------------- 1 file changed, 31 deletions(-) diff --git a/src/doc/index.md b/src/doc/index.md index e60468e483f..d0dde957a75 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -39,37 +39,6 @@ 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. -# 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: From 6ca0fa9af2ec96439ef2cbb4047f78c7adb2fe5e Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Tue, 3 Nov 2015 12:52:18 -0800 Subject: [PATCH 5/7] doc: Add the Rustonomicon --- src/doc/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/doc/index.md b/src/doc/index.md index d0dde957a75..79f3e0aad4d 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -31,6 +31,13 @@ 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 +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 From 48c170df36ed5e7ee47ca011b0169a0a7acd199c Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Tue, 3 Nov 2015 12:55:03 -0800 Subject: [PATCH 6/7] doc: Link to cargo docs, not just crates.io --- src/doc/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/index.md b/src/doc/index.md index 79f3e0aad4d..89fa45a3ad6 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -40,7 +40,7 @@ how to write `unsafe` Rust code. It is for advanced Rust programmers. # 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 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 From 5cc0a37123258fd5207a6e67723ea2c83bc89101 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Mon, 16 Nov 2015 11:48:18 -0800 Subject: [PATCH 7/7] Minor tweaks to doc index --- src/doc/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/doc/index.md b/src/doc/index.md index 89fa45a3ad6..5f2ef610729 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -33,14 +33,14 @@ something if you know its name. # The Rustonomicon -[The Rustonomicon] is an entire book dedicated dedicated to explaining +[The Rustonomicon] is an entire book dedicated to explaining how to write `unsafe` Rust code. It is for advanced Rust programmers. [The Rustonomicon]: nomicon/index.html # Tools -[Cargo](http://doc.crates.io/index.html) is the Rust's package manager providing access to libraries +[Cargo](http://doc.crates.io/index.html) is the Rust 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