Skip to content

Commit 4665aae

Browse files
committed
Auto merge of #28815 - matklad:contrib-doc, r=steveklabnik
This adds a paragraph on how to generate documentation without sloooow `make doc`. I'm not a native English speaker, so there might be some language related bugs (I wish English was as hard to get wrong, as Rust) This also includes whitespace cleanup of contributing.md in a separate commit. Whiltespace is not significant in github flavored markdown, and my Emacs just cleans ws automatically :) r? @steveklabnik
2 parents f492ec4 + c3753ce commit 4665aae

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

CONTRIBUTING.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,15 @@ To save @bors some work, and to get small changes through more quickly, when
145145
the other rollup-eligible patches too, and they'll get tested and merged at
146146
the same time.
147147

148-
To find documentation-related issues, sort by the [A-docs label][adocs].
148+
To find documentation-related issues, sort by the [A-docs label][adocs].
149149

150150
[adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs
151151

152+
In many cases, you don't need a full `make doc`. You can use `rustdoc` directly
153+
to check small fixes. For example, `rustdoc src/doc/reference.md` will render
154+
reference to `doc/reference.html`. The CSS might be messed up, but you can
155+
verify that HTML is right.
156+
152157
## Issue Triage
153158

154159
Sometimes, an issue will stay open, even though the bug has been fixed. And
@@ -164,30 +169,30 @@ Contributors with sufficient permissions on the Rust repo can help by adding
164169
labels to triage issues:
165170

166171
* Yellow, **A**-prefixed labels state which **area** of the project an issue
167-
relates to.
172+
relates to.
168173

169-
* Magenta, **B**-prefixed labels identify bugs which **belong** elsewhere.
174+
* Magenta, **B**-prefixed labels identify bugs which **belong** elsewhere.
170175

171176
* Green, **E**-prefixed labels explain the level of **experience** necessary
172177
to fix the issue.
173178

174179
* Red, **I**-prefixed labels indicate the **importance** of the issue. The
175180
[I-nominated][inom] label indicates that an issue has been nominated for
176-
prioritizing at the next triage meeting.
181+
prioritizing at the next triage meeting.
177182

178183
* Orange, **P**-prefixed labels indicate a bug's **priority**. These labels
179184
are only assigned during triage meetings, and replace the [I-nominated][inom]
180-
label.
185+
label.
181186

182187
* Blue, **T**-prefixed bugs denote which **team** the issue belongs to.
183188

184189
* Dark blue, **beta-** labels track changes which need to be backported into
185-
the beta branches.
186-
190+
the beta branches.
191+
187192
* The purple **metabug** label marks lists of bugs collected by other
188-
categories.
193+
categories.
189194

190-
If you're looking for somewhere to start, check out the [E-easy][eeasy] tag.
195+
If you're looking for somewhere to start, check out the [E-easy][eeasy] tag.
191196

192197
[inom]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated
193198
[eeasy]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy

0 commit comments

Comments
 (0)