diff options
| author | Dylan MacKenzie <ecstaticmorse@gmail.com> | 2020-04-28 08:55:41 -0700 |
|---|---|---|
| committer | Dylan MacKenzie <ecstaticmorse@gmail.com> | 2020-04-28 08:55:41 -0700 |
| commit | 23dbd33d9372bdb422eeb3978f4af90faebfb989 (patch) | |
| tree | 7ec15b85877a5da934e33de5f056fce34e29e8e6 /CONTRIBUTING.md | |
| parent | d7afaa7247cc81e0cca7aa438aa1e1672328c0a2 (diff) | |
Direct contributors to try stage 0 rustdoc first
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 051f5af7bc1..121aa1dbf0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -393,10 +393,14 @@ You can find documentation style guidelines in [RFC 1574][rfc1574]. [rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text -In many cases, you don't need a full `./x.py doc`. You can use `rustdoc` directly -to check small fixes. For example, `rustdoc src/doc/reference.md` will render -reference to `doc/reference.html`. The CSS might be messed up, but you can -verify that the HTML is right. +In many cases, you don't need a full `./x.py doc`, which will build the entire +stage 2 compiler. When updating documentation for the standard library, first +try `./x.py doc --stage 0 src/libstd`. Results will should appear in +`build/$TARGET/crate-docs`. + +You can also use `rustdoc` directly to check small fixes. For example, +`rustdoc src/doc/reference.md` will render reference to `doc/reference.html`. +The CSS might be messed up, but you can verify that the HTML is right. Additionally, contributions to the [rustc-dev-guide] are always welcome. Contributions can be made directly at [the |