Skip to content

Commit

Permalink
Merge pull request #14 from steveklabnik/docs-update-for-aturon
Browse files Browse the repository at this point in the history
some revisions for docs section of the roadmap
  • Loading branch information
aturon authored Feb 12, 2018
2 parents aba6cdb + 1b49783 commit 3ec1b78
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions text/0000-roadmap-2018.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,15 +159,31 @@ In preparation for the epoch release, we will continue to invest in Rust’s lib

#### Documentation

Documentation plays a *critical* role in the epoch release, as it’s often an entry point for people who are taking a look at Rust thanks to our marketing push. With regards to the epoch specifically, this mostly means updating the online version of “The Rust Programming Language” to include all of the new things that are being stabilized in the first part of the year.

We’ll also be doing a lot of work on Rust By Example. This resource is both critical for our users and also slightly neglected; we’re starting to put together a small team to give it some love, and so we hope to improve it significantly from there.

There are two additional areas of vital documentation work for 2018, which are not *necessarily* tied to the epoch release:


- **Resources for intermediate Rustaceans**. This topic is covered in detail below. It’s possible that some of these resources will be ready to go by the epoch release.
- **Overhauled rustdoc**. There’s ongoing work on an RLS-based edition of rustdoc with internationalization support, and the ability to seamlessly integrate “guide” and “reference”-style documentation. As a stretch goal for the epoch, we could aim to have this shipped and major libraries using it to provide a better documentation experience.
Documentation plays a *critical* role in the epoch release, as it’s often an
entry point for people who are taking a look at Rust thanks to our marketing
push. With regards to the epoch specifically, this mostly means updating the
online version of “The Rust Programming Language” to include all of the new
things that are being stabilized in the first part of the year. Along those
lines, other resouces, like the Reference and Rust By Example, will also need
to be updated to incorporate those new features as well.

##### Domain focuses

While the documentation team has no explicit tie to the various domains
we want to improve Rust on for the year, there's a lot we can do to
support these efforts! We will be somewhat following the libs team here:
originally, the libs team was mostly about working on the standard library,
but will be growing working groups to support the ecosystem. It's the same
for docs: we'll want to help the broader ecosystem to level up their
documentation.

A key part of this is the new revision to Rustdoc. While we don't want
to commit to shipping it for the epoch, it would be wonderful if it
happens. While this RFC is not about specifying exactly what the new
rustdoc is, it's intended to take a more holistic view of documentation,
incorporating guide-level documentation as well as API documentation,
for example. These tools should help a number of projects offer more
than just basic API docs.

#### Tools

Expand Down

0 comments on commit 3ec1b78

Please sign in to comment.