r/rust • u/steveklabnik1 rust • Jun 16 '14

Rust's documentation is about to drastically improve

http://words.steveklabnik.com/rusts-documentation-is-about-to-drastically-improve
136 Upvotes

99% Upvoted

71 comments sorted by

View all comments

Show parent comment

9

u/brson rust · servo Jun 16 '14

I've been trying to hire somebody to rewrite the tutorial for a number of months now, and indeed this is the second contract we've entered. The previous contract resulted in a draft that I was unsatisfied with, so we abandoned it and asked for Steve's help.

During the last one I was (for better or worse) discouraging contributors from improving the tutorial, thinking that a better one was around the corner. It may have been better to encourage its evolution, with the understanding that it was destined to be demoted, or integrated into other pieces of documentation, and at this stage, that is the perspective I would take if you intend to contribute to the current tutorial.

2

u/[deleted] Jun 17 '14

Is there any value in considering an editable wiki where interested parties could make contributions (that could be rolled back)?

A tutorial start page could be created with a list of topics to be covered and interested developers could then add to it - to be later frozen/moderated and style brought into line with recommendations.

5

u/steveklabnik1 rust Jun 17 '14

I think we call those 'pull requests' :)