RWIB Mission 5 Documentation Page

[ghost]

This is a copy of the landing page in the documentation tree.

No changes to content, only cleanup of formatting.

I checked to see if there were any links in the documentation tree that required redirection in the documentation tree but there were none.

[rust-highfive]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @brson (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

[brson]

I've pushed PRS #201 (community), #200 (docs), and #199 (contributing) to my own gh pages so reviewers can see. The first goal is to get the community page merged since it's the most developed.

The key pages under review are community.html, user_groups.html, documentation.html, and contributions.html

[brson]

My focus is on the contributing page right now, but here are some thoughts on this one.

This is the documentation landing page for all of Rust; that includes the in-tree docs for all three channels, possibly docs for historical releases, the upcoming FAQ (hosted on the website), community and foreign translations, and crucially, this will also be the way we direct people to the vast amounts of non-official documentation for Rust, books.

Much of this page will subsume the in-tree doc index, but that page needs to continue to exist in a limited form. After this change I'd expect the in-tree index to contain the bare minimum: perhaps links to the books, the api docs and the error docs.

'Getting started' is definitely the right starting section for the doc page.

Next should be the 'Official documentation' or 'release documentation' (the in-tree docs). I'm not sure how to organize this offhand, whether we should relist all the in-tree doc components or just link to the in-tree landing page; we also have to link to multiple channels' documentation.

A lot of the unofficial docs we want people to find are available in rust-learning.

Ideas about categorization on this page:

• getting started
• getting help (maybe combined with the above) - this should not be as extensive as the existing, perhaps just #rust-beginners, stackoverflow and urlo.
• api - needs to link to various releases
• books and tutorials
• faq
• foreign language resources

Here's Scala's page for reference - they interestingly begin with a menu of sorts for all the types of docs one might want, then go to the introductory stuff.

Some of the resources I think need to be exposed (all available from rust-learning):

• rustonomicon
• rust 101
• rust-learning
• entirely too many linked lists
• periodic table of rust types
• good practices for writing rust libraries

Sorry this has taken so long and is just a brain dump.

[brson]

I've opened a new PR.