Skip to content

Commit 3ec1b78

Browse files
authored
Merge pull request #14 from steveklabnik/docs-update-for-aturon
some revisions for docs section of the roadmap
2 parents aba6cdb + 1b49783 commit 3ec1b78

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

text/0000-roadmap-2018.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -159,15 +159,31 @@ In preparation for the epoch release, we will continue to invest in Rust’s lib
159159

160160
#### Documentation
161161

162-
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.
163-
164-
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.
165-
166-
There are two additional areas of vital documentation work for 2018, which are not *necessarily* tied to the epoch release:
167-
168-
169-
- **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.
170-
- **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.
162+
Documentation plays a *critical* role in the epoch release, as it’s often an
163+
entry point for people who are taking a look at Rust thanks to our marketing
164+
push. With regards to the epoch specifically, this mostly means updating the
165+
online version of “The Rust Programming Language” to include all of the new
166+
things that are being stabilized in the first part of the year. Along those
167+
lines, other resouces, like the Reference and Rust By Example, will also need
168+
to be updated to incorporate those new features as well.
169+
170+
##### Domain focuses
171+
172+
While the documentation team has no explicit tie to the various domains
173+
we want to improve Rust on for the year, there's a lot we can do to
174+
support these efforts! We will be somewhat following the libs team here:
175+
originally, the libs team was mostly about working on the standard library,
176+
but will be growing working groups to support the ecosystem. It's the same
177+
for docs: we'll want to help the broader ecosystem to level up their
178+
documentation.
179+
180+
A key part of this is the new revision to Rustdoc. While we don't want
181+
to commit to shipping it for the epoch, it would be wonderful if it
182+
happens. While this RFC is not about specifying exactly what the new
183+
rustdoc is, it's intended to take a more holistic view of documentation,
184+
incorporating guide-level documentation as well as API documentation,
185+
for example. These tools should help a number of projects offer more
186+
than just basic API docs.
171187

172188
#### Tools
173189

0 commit comments

Comments
 (0)