This describes what the documentation subteam tasks would do and what it wouldn't do as well.
Since the documentation team work would cover some parts currently handled by the libs team, it would make more sense to make it a subteam of the libs team.
The documentation subteam would initially handle the following tasks:
- Helping with public crates documentation.
- Maintain documentation guidelines.
- Creating an external resources page.
Let's describe them.
By "public crates", I'm referring to core, alloc, std, proc_macro and test. However, if other public crates are added, they would also be included.
By "helping", I meant that the goal of this subteam would be to help with writing the documentation (or even writing it if it's missing), ensuring the documentation is clear for users and enforce the documentation guidelines (available here).
Of course, if someone wants to write documentation and want some help, we will be there for them.
As mentioned previously, the guidelines are available here. As things evolve, they might need to be updated. This is something that should be handled by this subteam.
It is a common complaint for Rust beginners that once they're done reading the "Rust Book", they often lack tutorials on how to do more advanced things. The goal of this web page would be list external resources (such as blog posts) grouped by topics.
The documentation subteam would maintain its page by handling the listing and also review potential new adds.
This subteam would focus on Rust users and the documentation they go through. So anything internal-related (like compiler documentation) is out of scope.
The Rust Book is currently out of scope because it is in a complicated state where changes have to take into account their impact on the print version. It might become part of the responsibilities of this subteam in the future once everything is running smoothly and someone steps up to handle it.
Initially, @GuillaumeGomez and @LucasDumont.