diff options
| author | follower <follower@rancidbacon.com> | 2020-09-27 04:22:47 +1300 |
|---|---|---|
| committer | Joshua Nelson <joshua@yottadb.com> | 2020-09-27 10:37:22 -0400 |
| commit | edceee064f4f625cf06b004f6d9900adeea33569 (patch) | |
| tree | a4b40245129a829487ecb09334f9d66bb2e057de /src/doc/rustc-dev-guide | |
| parent | 8a8ae8ca9bb5fe40c50da2104b9c73cd91a49b90 (diff) | |
| download | rust-edceee064f4f625cf06b004f6d9900adeea33569.tar.gz rust-edceee064f4f625cf06b004f6d9900adeea33569.zip | |
Add links to documentation sources.
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/contributing.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/contributing.md b/src/doc/rustc-dev-guide/src/contributing.md index 0415f8e08fd..ba446b2745f 100644 --- a/src/doc/rustc-dev-guide/src/contributing.md +++ b/src/doc/rustc-dev-guide/src/contributing.md @@ -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 |