3 ms·

I don't want to make you rewrite this if you've already answered this elsewhere, but... Could you provide some pointers about how to begin with contributing to

I don't want to make you rewrite this if you've already answered this elsewhere, but... Could you provide some pointers about how to begin with contributing to the Rust documentation? What are the areas that need the most help or have received the most complaints/confused reactions? I actually like writing docs but I'm not sure where I'd begin. (And of course not super confident in my understanding of Rust in the first place since I'm still learning it myself. But I know a lot more than someone looking at it for the first time.)

kibwen 11y ago
One thing you can do if you'd like to help with docs is to flesh out Rust By Example: https://github.com/rust-lang/rust-by-example https://github.com/rust-lang/rust-by-example . It began as a community project but was then adopted by the core developers at the behest of the community, but it's seen much less love than the official docs. If you're interested you'd be largely free to make it your own. :)
steveklabnik 11y ago
I'd love to have some contributions! One easy way to contribute is to find something that doesn't currently have any examples, and add some. http://doc.rust-lang.org/stable/book/documentation.html http://doc.rust-lang.org/stable/book/documentation.html is a basic guide to writing docs, and I'm quite happy to workshop a PR with some basics into something more. Currently, the areas that need most help fall into two categories: intermediate/advanced docs, and API documentation. The latter is an easier place to get started, I'd imagine. Hence my suggestion of examples. We also have the A-docs tag: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Ais... Some of these are actually pretty easy, I tend to let the pile up and then knock out 10+ in a day if nobody else gets them first. I can get more specific than that if you'd like, but I think that's a pretty decent high-level overview.

kibwen 11y ago

One thing you can do if you'd like to help with docs is to flesh out Rust By Example: https://github.com/rust-lang/rust-by-example https://github.com/rust-lang/rust-by-example . It began as a community project but was then adopted by the core developers at the behest of the community, but it's seen much less love than the official docs. If you're interested you'd be largely free to make it your own. :)

steveklabnik 11y ago

I'd love to have some contributions! One easy way to contribute is to find something that doesn't currently have any examples, and add some. http://doc.rust-lang.org/stable/book/documentation.html http://doc.rust-lang.org/stable/book/documentation.html is a basic guide to writing docs, and I'm quite happy to workshop a PR with some basics into something more. Currently, the areas that need most help fall into two categories: intermediate/advanced docs, and API documentation. The latter is an easier place to get started, I'd imagine. Hence my suggestion of examples. We also have the A-docs tag: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Ais... Some of these are actually pretty easy, I tend to let the pile up and then knock out 10+ in a day if nobody else gets them first. I can get more specific than that if you'd like, but I think that's a pretty decent high-level overview.