Skip to content

Commit 23dbd33

Browse files
Direct contributors to try stage 0 rustdoc first
1 parent d7afaa7 commit 23dbd33

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

CONTRIBUTING.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -393,10 +393,14 @@ You can find documentation style guidelines in [RFC 1574][rfc1574].
393393

394394
[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
395395

396-
In many cases, you don't need a full `./x.py doc`. You can use `rustdoc` directly
397-
to check small fixes. For example, `rustdoc src/doc/reference.md` will render
398-
reference to `doc/reference.html`. The CSS might be messed up, but you can
399-
verify that the HTML is right.
396+
In many cases, you don't need a full `./x.py doc`, which will build the entire
397+
stage 2 compiler. When updating documentation for the standard library, first
398+
try `./x.py doc --stage 0 src/libstd`. Results will should appear in
399+
`build/$TARGET/crate-docs`.
400+
401+
You can also use `rustdoc` directly to check small fixes. For example,
402+
`rustdoc src/doc/reference.md` will render reference to `doc/reference.html`.
403+
The CSS might be messed up, but you can verify that the HTML is right.
400404

401405
Additionally, contributions to the [rustc-dev-guide] are always welcome. Contributions
402406
can be made directly at [the

0 commit comments

Comments
 (0)