Skip to content

Commit 35b702b

Browse files
followerJoshua Nelson
authored and
Joshua Nelson
committed
Add links to documentation sources.
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
1 parent 5f39b81 commit 35b702b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/contributing.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -373,10 +373,13 @@ the submodule to. Running `./x.py build` should work now.
373373
## Writing Documentation
374374

375375
Documentation improvements are very welcome. The source of `doc.rust-lang.org`
376-
is located in `src/doc` in the tree, and standard API documentation is generated
377-
from the source code itself. Documentation pull requests function in the same way
376+
is located in [`src/doc`][srcdoc] in the tree, and standard API documentation is generated
377+
from the source code itself (e.g. [`lib.rs`][librs]). Documentation pull requests function in the same way
378378
as other pull requests.
379379

380+
[srcdoc]: https://github.com/rust-lang/rust/tree/master/src/doc
381+
[librs]: https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1
382+
380383
To find documentation-related issues, sort by the [T-doc label][tdoc].
381384

382385
[tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc

0 commit comments

Comments
 (0)