Skip to content

Commit c3753ce

Browse files
committed
docs: add rustdoc example to CONTRIBUTING.md
1 parent e3596e3 commit c3753ce

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,11 @@ 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

0 commit comments

Comments
 (0)