mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add links to documentation sources. 

Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
This commit is contained in:
follower 2020-09-27 04:22:47 +13:00 committed by Joshua Nelson
parent edc31ef0bc
commit 1e77d7f743
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/contributing.md
View File

@ -373,10 +373,13 @@ the submodule to. Running `./x.py build` should work now.
## Writing Documentation
Documentation improvements are very welcome. The source of `doc.rust-lang.org`
is located in `src/doc` in the tree, and standard API documentation is generated
from the source code itself. Documentation pull requests function in the same way
is located in [`src/doc`][srcdoc] in the tree, and standard API documentation is generated
from the source code itself (e.g. [`lib.rs`][librs]). Documentation pull requests function in the same way
as other pull requests.
[srcdoc]: https://github.com/rust-lang/rust/tree/master/src/doc
[librs]: https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1
To find documentation-related issues, sort by the [T-doc label][tdoc].
[tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc