Skip to content

Commit d4639ad

Browse files
committed
doc: Update style of index, organization and trim out some excess.
1 parent f5ee077 commit d4639ad

File tree

1 file changed

+32
-144
lines changed

1 file changed

+32
-144
lines changed

doc/index.md

+32-144
Original file line numberDiff line numberDiff line change
@@ -1,157 +1,45 @@
11
% Rust documentation
22

3-
# Reference docs
3+
<!-- Completely hide the TOC and the section numbers -->
4+
<style type="text/css">
5+
#TOC { display: none; }
6+
.header-section-number { display: none; }
7+
</style>
48

5-
**Current (0.9)**
9+
[The Rust tutorial](tutorial.html)
10+
[The Rust reference manual](rust.html) ([PDF](rust.pdf))
611

7-
* [Tutorial](http://doc.rust-lang.org/doc/0.9/tutorial.html)
8-
* Guides
9-
* [borrowed pointers](http://doc.rust-lang.org/doc/0.9/guide-borrowed-ptr.html)
10-
* [conditions](http://doc.rust-lang.org/doc/0.9/guide-conditions.html)
11-
* [containers & iterators](http://doc.rust-lang.org/doc/0.9/guide-container.html)
12-
* [ffi](http://doc.rust-lang.org/doc/0.9/guide-ffi.html)
13-
* [macros](http://doc.rust-lang.org/doc/0.9/guide-macros.html)
14-
* [rustpkg](http://doc.rust-lang.org/doc/0.9/guide-rustpkg.html)
15-
* [tasks](http://doc.rust-lang.org/doc/0.9/guide-tasks.html)
16-
* [testing](http://doc.rust-lang.org/doc/0.9/guide-testing.html)
17-
* [Manual](http://doc.rust-lang.org/doc/0.9/rust.html) ([PDF](http://doc.rust-lang.org/doc/0.9/rust.pdf))
18-
* [Standard library](http://doc.rust-lang.org/doc/0.9/std/index.html)
19-
* [Extra library](http://doc.rust-lang.org/doc/0.9/extra/index.html)
20-
* [Package manager](http://doc.rust-lang.org/doc/0.9/rustpkg.html)
12+
# Guides
2113

22-
**In-development (git master)**
14+
[Borrowed Pointers](guide-borrowed-ptr.html)
15+
[Lifetimes](guide-lifetimes.html)
16+
[Containers and Iterators](guide-container.html)
17+
[Tasks and Communication](guide-tasks.html)
18+
[Foreign Function Interface](guide-ffi.html)
19+
[Macros](guide-macros.html)
20+
[Packaging](guide-rustpkg.html)
21+
[Testing](guide-testing.html)
22+
[Conditions](guide-conditions.html)
2323

24-
* [Tutorial](http://doc.rust-lang.org/doc/master/tutorial.html) ([PDF](http://doc.rust-lang.org/doc/master/tutorial.pdf))
25-
* Guides
26-
* [borrowed pointers](http://doc.rust-lang.org/doc/master/guide-borrowed-ptr.html)
27-
* [conditions](http://doc.rust-lang.org/doc/master/guide-conditions.html)
28-
* [containers & iterators](http://doc.rust-lang.org/doc/master/guide-container.html)
29-
* [ffi](http://doc.rust-lang.org/doc/master/guide-ffi.html)
30-
* [macros](http://doc.rust-lang.org/doc/master/guide-macros.html)
31-
* [rustpkg](http://doc.rust-lang.org/doc/master/guide-rustpkg.html)
32-
* [tasks](http://doc.rust-lang.org/doc/master/guide-tasks.html)
33-
* [testing](http://doc.rust-lang.org/doc/master/guide-testing.html)
34-
* [Manual](http://doc.rust-lang.org/doc/master/rust.html) ([PDF](http://doc.rust-lang.org/doc/master/rust.pdf))
35-
* [Standard library](http://doc.rust-lang.org/doc/master/std/index.html)
36-
* [Extra library](http://doc.rust-lang.org/doc/master/extra/index.html)
37-
* [libgreen](http://static.rust-lang.org/doc/master/green/index.html)
38-
* [libnative](http://static.rust-lang.org/doc/master/native/index.html)
39-
* [Package manager](http://doc.rust-lang.org/doc/master/rustpkg.html)
24+
# Libraries
4025

41-
# FAQs
42-
43-
* [Language FAQ][lang-faq]
44-
* [Project FAQ][project-faq]
45-
* [Usage FAQ][usage-faq]
46-
* [Code cheatsheet][cheatsheet] - "How do I do X?"
47-
* [HOWTO submit a bug report][bugreport]
48-
49-
[lang-faq]: complement-lang-faq.html
50-
[project-faq]: complement-project-faq.html
51-
[usage-faq]: complement-usage-faq.html
52-
[cheatsheet]: complement-cheatsheet.html
53-
[bugreport]: complement-bugreport.html
54-
55-
# Community
56-
57-
58-
> **Note** that to guard against botnet attacks we occasionally turn on moderation, disallowing
59-
> unregistered users from joining or talking. You may need to [register](https://wiki.mozilla.org/IRC#Register_your_nickname) your nickname. Sorry for the inconvenience.*
26+
[std](std/index.html)
27+
[extra](index.html)
6028

61-
* IRC
62-
* [#rust on irc.mozilla.org][pound-rust] - Main Rust channel - general discussion
63-
* [#rust-internals on irc.mozilla.org][pound-rust-internals] - Rust compiler and library development
64-
* [#rust-gamedev on irc.mozilla.org][pound-rust-gamedev] - game development in Rust
65-
* [#rust-osdev on irc.mozill.org][pound-rust-osdev] - OS development in Rust
66-
* [#rust on irc.ozinger.org][pound-rust-korea] - Korean Rust community
29+
# Tooling
6730

68-
* Mailing list [rust-dev]
69-
* Reddit's [r/rust]
70-
* User groups
71-
* [Rust Bay Area][rust-bay-area]
72-
* [Rust Korea][rust-korea]
73-
* [Rust Skåne][rust-skane]
74-
* [Rust 中文圈][rust-zh] (on Google+)
31+
[The rustpkg manual](rustpkg.html)
7532

76-
[pound-rust]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust
77-
[pound-rust-internals]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
78-
[pound-rust-gamedev]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev
79-
[pound-rust-osdev]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev
80-
[pound-rust-korea]: http://chat.mibbit.com/?server=irc.ozinger.org&channel=%23rust
81-
[rust-dev]: https://mail.mozilla.org/listinfo/rust-dev
82-
[r/rust]: http://reddit.com/r/rust
83-
[rust-bay-area]: http://www.meetup.com/Rust-Bay-Area/
84-
[rust-korea]: http://rust-kr.org/
85-
[rust-skane]: http://www.meetup.com/rust-skane/
86-
[rust-zh]: https://plus.google.com/communities/100629002107624231185/
87-
88-
# Specialized documentation
89-
90-
[Releases][release-notes] - Links to current and old releases and documentation
91-
[Detailed release notes][detailed-release-notes] - Further explanation of language changes
92-
[Rust for C++ programmers][rust-for-c] - A cheat sheet
93-
[Rusticon][rust-icon] - A glossary of terms commonly used in Rust and Rust tools.
94-
[Unit testing][unit-testing] - Writing tests and running them with the built-in test driver
95-
[Using rustpkg][rustpkg] - Managing packages
96-
[Using rustdoc][rustdoc] - How to extract Markdown and HTML documentation from code
97-
[Package documentation](http://docs.octayn.net/) - Documentation for rust packages
98-
[Continuous integration][ci] - Test your GitHub-hosted packages with Travis CI
99-
[Reading and writing files][doc-rw]
100-
[Attributes][doc-attributes] - The role of metadata in Rust code, with descriptions of many applications
101-
[Packages, editors, and other tools][tools]
102-
[Packaging Terminology][doc-terminology]
103-
[Crate Hashes][crate-hashes] - How Rust generates crate filenames, versions symbols, and why
104-
[Computer Graphics and Game Development][game-dev] - Libraries and example projects
105-
[Pr&eacute;sentation du langage Rust](http://lea-linux.org/documentations/Rust) - Detailed documentation in French, with examples
106-
[Building for Android][building-android]
107-
[Building for iOS][building-ios]
108-
109-
[release-notes]: https://github.com/mozilla/rust/wiki/Doc-releases
110-
[detailed-release-notes]: https://github.com/mozilla/rust/wiki/Doc-detailed-release-notes
111-
[rust-for-c]: https://github.com/mozilla/rust/wiki/Rust-for-CXX-programmers
112-
[rust-icon]: https://github.com/mozilla/rust/wiki/The-Rusticon
113-
[unit-testing]: https://github.com/mozilla/rust/wiki/Doc-unit-testing
114-
[rustpkg]: https://github.com/mozilla/rust/wiki/Rustpkg
115-
[rustdoc]: https://github.com/mozilla/rust/wiki/Doc-using-rustdoc
116-
[ci]: https://github.com/mozilla/rust/wiki/Doc-continuous-integration
117-
[doc-rw]: https://github.com/mozilla/rust/wiki/Doc-reading-and-writing-files
118-
[doc-attributes]: https://github.com/mozilla/rust/wiki/Doc-attributes
119-
[tools]: https://github.com/mozilla/rust/wiki/Doc-packages%2C-editors%2C-and-other-tools
120-
[doc-terminology]: https://github.com/mozilla/rust/wiki/Doc-packaging-terminology
121-
[crate-hashes]: https://github.com/mozilla/rust/wiki/Doc-crate-hashes
122-
[game-dev]: https://github.com/mozilla/rust/wiki/Computer-Graphics-and-Game-Development
123-
[building-android]: https://github.com/mozilla/rust/wiki/Doc-building-for-android
124-
[building-ios]: https://github.com/mozilla/rust/wiki/Doc-building-for-ios
125-
126-
Some Rust classics:
33+
# FAQs
12734

128-
* [Pointers in Rust: A Guide](http://words.steveklabnik.com/pointers-in-rust-a-guide)
129-
* [A taste of Rust](https://lwn.net/Articles/547145/)
130-
* [An overview of memory management in Rust](http://pcwalton.github.com/blog/2013/03/18/an-overview-of-memory-management-in-rust/)
131-
* [Which pointer should I use?](http://pcwalton.github.com/blog/2013/03/09/which-pointer-should-i-use/)
132-
* [Lifetimes explained](http://maikklein.github.io/2013/08/27/lifetimes-explained/)
133-
* [Little things that matter in language design](http://lwn.net/Articles/553131/)
134-
* [Operator overloading in Rust](http://maniagnosis.crsr.net/2013/04/operator-overloading-in-rust.html)
135-
* [Embedding Rust in Ruby](http://brson.github.com/2013/03/10/embedding-rust-in-ruby/)
136-
* [A first parallel program in Rust](http://blog.leahhanson.us/a-first-parallel-program-in-rust.html)
137-
* [FizzBuzz revisited](http://composition.al/blog/2013/03/02/fizzbuzz-revisited/)
138-
* [Ownership types in Rust, and whether they're worth it](http://tim.dreamwidth.org/1784423.html)
139-
* [Reasoning about the heap in Rust](http://johnbender.us/2013/04/30/reasoning-about-the-heap-in-rust)
140-
* [The Option Type](http://nickdesaulniers.github.io/blog/2013/05/07/rust-pattern-matching-and-the-option-type/)
141-
* [How I got started hacking rustc](http://cmr.github.io/blog/2013/06/23/how-i-got-started-with-rust/)
142-
* [Abstraction penalties, stack allocation, and ownership types](http://robert.ocallahan.org/2007/10/abstraction-penalties-stack-allocation_23.html)
143-
* [Présentation de Rust 0.8](http://linuxfr.org/news/presentation-de-rust-0-8) - A very detailed article about Rust 0.8, in French!
35+
[Language FAQ](complement-lang-faq.html)
36+
[Project FAQ](complement-project-faq.html)
37+
[Usage FAQ](complement-usage-faq.html)
38+
[Code cheatsheet](complement-cheatsheet.html) - "How do I do X?"
39+
[HOWTO submit a bug report](complement-bugreport.html)
14440

145-
# Presentations
41+
# External resources
14642

147-
* [John Clements, 10-minute talk (video)](http://www.youtube.com/watch?v=_KgXy7jnwhY) at SoCal PLS on Rust, Macros, and Hygiene. December 2013.
148-
* [Felix's Codemesh 2013 slides](http://pnkfelix.github.io/present-rust-codemesh2013/fklock-rust-codemesh2013.pdf)
149-
* Geoffroy Couprie's [Scala.IO 2013 slides](http://dev.unhandledexpression.com/slides/rust-scalaio/)
150-
* Steve's presentation at RuPy 2013 "Nobody Knows Rust." [slides](http://steveklabnik.github.io/nobody_knows_rust/#/), video to come soon
151-
* [Tim's presentation at OS Bridge 2013](http://opensourcebridge.org/sessions/970) - And [slides](http://opensourcebridge.org/wiki/2013/Rust%3A_A_Friendly_Introduction)
152-
* [Niko's presentation at Northeastern](http://smallcultfollowing.com/babysteps/blog/2013/07/18/rust-presentation-at-northeastern/) - Slides only
153-
* [An I/O system for Rust](https://air.mozilla.org/intern-presentations-reed/) - Eric Reed's intern presentation on I/O
154-
* [Types of Types](https://air.mozilla.org/ben-blum-from-the-research-team-presents-types-of-types-in-rust/) - Ben Blum's intern presentation on 'kinds'
155-
* [Default methods in Rust](https://air.mozilla.org/intern-presentation-sullivan/) - Michael Sullivan's intern presentation on default methods
156-
* [A work stealing runtime for Rust](https://air.mozilla.org/2013-intern-todd/) - Aaron Todd's intern presentation on the Rust scheduler
157-
* [Dave Herman's StrangeLoop 2012 talk](http://www.infoq.com/presentations/Rust)
43+
The Rust [IRC channel](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - #rust on irc.mozilla.org
44+
The Rust community on [Reddit](http://reddit.com/r/rust)
45+
The Rust [wiki](http://github.com/mozilla/rust/wiki)

0 commit comments

Comments
 (0)