From 49254ac46cb01ca5de2d70ef1aefd33817d566cd Mon Sep 17 00:00:00 2001 From: Andrew Brinker Date: Fri, 15 Jan 2016 22:38:01 -0500 Subject: [PATCH] Updated typography --- contribute.md | 14 ++++----- documentation.md | 82 +++++++++++++++++++++++++++++------------------- 2 files changed, 56 insertions(+), 40 deletions(-) diff --git a/contribute.md b/contribute.md index 71f5725e9..8205e5584 100644 --- a/contribute.md +++ b/contribute.md @@ -21,20 +21,20 @@ mechanics of contributing to [rust-lang/rust]. There are many ways to contribute to the success of Rust. This guide focuses on a few avenues for the new contributor: -* [**Finding, triaging and fixing issues**](contribute-bugs.html). The +* [Finding, triaging and fixing issues](contribute-bugs.html). The basic work of maintaining a large and active project like Rust. -* [**Documentation**](contribute-docs.html). Not just official +* [Documentation](contribute-docs.html). Not just official documentation, but also for crates, blog posts, and other unofficial sources. -* [**Community building**](contribute-community.html). Helping your fellow +* [Community building](contribute-community.html). Helping your fellow Rustacean, and expanding the reach of Rust. -* [**Tooling, IDEs and infrastructure**](contribute-tools.html). The +* [Tooling, IDEs and infrastructure](contribute-tools.html). The important pieces that make using a language practical and painless. -* [**Libraries**](contribute-libs.html). Rust's suitability for any +* [Libraries](contribute-libs.html). Rust's suitability for any particular task is mostly dependent on availability of quality libraries. -* [**Language, compiler and the standard - library**](contribute-compiler.html). Language design, feature +* [Language, compiler and the standard + library](contribute-compiler.html). Language design, feature implementation, performance improvement. If you need additional guidance ask on [#rust-internals] or diff --git a/documentation.md b/documentation.md index 87c5c0403..b262c4b40 100644 --- a/documentation.md +++ b/documentation.md @@ -6,55 +6,67 @@ title: Rust Documentation · The Rust Programming Language # Rust Documentation If you haven't seen Rust at all yet, the first thing you should read -is the introduction to the book, [**The Rust Programming -Language**][book]. It will give you a good idea of what Rust is like, +is the introduction to the book, [The Rust Programming +Language][book]. It will give you a good idea of what Rust is like, show you how to install it, and explain its syntax and concepts. Upon completing the book, you'll be an intermediate Rust developer, and will have a good grasp of the fundamental ideas behind Rust. ## Learning Rust -[**The Rust Programming Language**][book]. Also known as "The Book", -The Rust Programming Language is the most comprehensive resource for -all topics related to Rust, and is the primary official document of -the language. +### [The Rust Programming Language][book] -[**Rust by Example**][rbe]. A collection of self-contained Rust -examples on a variety of topics, executable in-browser. +Also known as "The Book", The Rust Programming Language is the most +comprehensive resource for all topics related to Rust, and is the +primary official document of the language. -[**Frequently asked questions**][faq]. +### [Rust by Example][rbe] -[**The Rustonomicon**][nomicon]. An entire book dedicated to -explaining how to write unsafe Rust code. It is for advanced Rust -programmers. +A collection of self-contained Rust examples on a variety of topics, +executable in-browser. -[**rust-learning**]. A community-maintained collection of resources -for learning Rust. +### [Frequently asked questions][faq]. + +A series of answers to common questions from the Rust community. + +### [The Rustonomicon][nomicon] + +An entire book dedicated to explaining how to write unsafe Rust code. +It is for advanced Rust programmers. + +### [rust-learning][rust-learning] + +A community-maintained collection of resources for learning Rust. [book]: https://doc.rust-lang.org/book/ [rbe]: http://rustbyexample.com [faq]: faq.html [nomicon]: https://doc.rust-lang.org/nomicon/ -[**rust-learning**]: https://github.com/ctjhoa/rust-learning +[rust-learning]: https://github.com/ctjhoa/rust-learning ## References -[**Standard Library API Reference**][api]. Documentation for the -standard library. +### [Standard Library API Reference][api] + +Documentation for the standard library. + +### [The Rust Reference][ref] -[**The Rust Reference**][ref]. While Rust does not have a -specification, the reference tries to describe its working in -detail. It tends to be out of date. +While Rust does not have a specification, the reference tries to +describe its working in detail. It tends to be out of date. -[**Syntax Index**][syn]. This appendix from The Book contains examples -of all syntax in Rust cross-referenced with the section of The Book -that describes it. +### [Syntax Index][syn] -[**The Cargo Guide**][cargo]. The documentation for Cargo, -Rust's package manager. +This appendix from The Book contains examples of all syntax in Rust +cross-referenced with the section of The Book that describes it. -[**Compiler Error Index**][err]. Extended explanations of -the errors produced by the Rust compiler. +### [The Cargo Guide][cargo] + +The documentation for Cargo, Rust's package manager. + +### [Compiler Error Index][err] + +Extended explanations of the errors produced by the Rust compiler. [api]: https://doc.rust-lang.org/std/ [syn]: https://doc.rust-lang.org/book/syntax-index.html @@ -64,13 +76,16 @@ the errors produced by the Rust compiler. ## Project policies -[**Rust security policy**][security]. The project's policies for -reporting, fixing and disclosing security-related bugs. +### [Rust security policy][security] -[**Rust copyright and trademark policies**][legal]. The Rust -copyrights are owned by The Rust Project Developers, and its -trademarks are owned by Mozilla. Appropriate usage of Rust's -trademarks are described here. +The project's policies for reporting, fixing and disclosing +security-related bugs. + +### [Rust copyright and trademark policies][legal] + +The Rust copyrights are owned by The Rust Project Developers, and its +trademarks are owned by Mozilla. Appropriate usage of Rust's trademarks +are described here. [security]: security.html [legal]: legal.html @@ -90,3 +105,4 @@ For resources in languages other than English, see the [locale-specific links in rust-learning][locale]. [locale]: https://github.com/ctjhoa/rust-learning#locale-links +