Skip to content

Add links to documentation sources. #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 27, 2020
Merged

Add links to documentation sources. #898

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff11f5e
Add links to documentation sources.
follower Sep 26, 2020
8132163
Fix line length error.
follower Sep 26, 2020
158fa22
Use implicit reference links for shorter lines
follower Sep 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,9 +373,12 @@ 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
as other pull requests.
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].

Expand Down