This Week in Rust Docs 1

Posted on April 11, 2016 by This week in Rust Docs

Hello and welcome to This Week in Rust Docs!

This Week in Rust Docs is openly developed on GitHub. If you find any errors in this week’s issue, please submit a PR.

This week’s edition was edited by: GuillaumeGomez.

Why this newsletter?

There isn’t an official Rust docs team yet, but several of us have decided to start working as a team, even though it’s not official. Here’s what we’ll be working on:

• Working on the front-end part of rustdoc.
• Working on error code explanations.
• Improving Rust documentation.
• Improving the Rustbook (also known as “The Book”).

Since documentation is a really important part of Rust, why not keep people up-to-date about what’s happening?

Latest news

In the two last weeks, we opened two RFCs:

• Normalization for long error codes explanations
• More api documentation conventions

Once they’re approved, the work on Rust documentation will certainly increase again. They both intend to normalize how to write specific documentation. Please take a look at them. :)

Current opened issues

For now, here are the issues opened for Rust documentation:

• The Standard Library Documentation Checklist
• Add error explanations for all error codes

They both need help to move forward so any contribution is very welcome!

Recent doc contributions

@GuillaumeGomez worked on both rustdoc front-end and documentation improvements. @Steveklabnik worked on The Standard Library Documentation Checklist RFC.

Meetings

Next meeting will be on Wednesday 13rd of April 2016 at 20:00 GMT on #rust-docs channel on irc.mozilla.org, feel free to come!