Update CONTRIBUTING.md regarding documentation contributions #40803
Conversation
Changed link to documentation issues from A-docs to T-doc as this has just been migrated. Added a link to the documentation style guidelines.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
steveklabnik
left a comment
steveklabnik
left a comment
There was a problem hiding this comment.
one tiny nit, and then r=me ❤️
CONTRIBUTING.md
Outdated
|
|
||
| To find documentation-related issues, sort by the [A-docs label][adocs]. | ||
| To find documentation-related issues, sort by the [T-doc label][tdoc]. | ||
| You can find documentation style guidelines in [RFC 1574][rfc1574]. |
There was a problem hiding this comment.
Could you put a newline above this? Markdown means that this will be one paragraph, let's make it two 😄
|
@bors: r+ rollup thanks so much! |
|
📌 Commit 7643ccd has been approved by |
…klabnik Update CONTRIBUTING.md regarding documentation contributions Changed link to documentation issues from A-docs to T-doc as this has just been migrated. Added a link to the documentation style guidelines in RFC 1574 (I've linked to [Appendix A][1] specifically since that's the combined version). r? @steveklabnik [1]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
4 participants
Changed link to documentation issues from A-docs to T-doc as this has just been migrated.
Added a link to the documentation style guidelines in RFC 1574 (I've linked to Appendix A specifically since that's the combined version).
r? @steveklabnik