Skip to content

Commit e29ab16

Browse files
committed
Add some comments to the docs issue template to clarify
Signed-off-by: Yuki Okushi <[email protected]>
1 parent 2f320a2 commit e29ab16

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

.github/ISSUE_TEMPLATE/documentation.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,28 @@ about: Create a report for a documentation problem.
44
labels: A-docs
55
---
66
<!--
7+
78
Thank you for finding a documentation problem! 📚
89
910
Documentation problems might be grammatical issues, typos, or unclear wording, please provide details regarding the documentation including where it is present.
1011
12+
Note: If your issue is for one of these, please use their dedicated issue tracker instead:
13+
14+
- The Rust Book: https://github.com/rust-lang/book/issues
15+
- Rust by Example: https://github.com/rust-lang/rust-by-example/issues
16+
- The Edition Guide: https://github.com/rust-lang/edition-guide/issues
17+
- The Cargo Book: https://github.com/rust-lang/cargo/issues
18+
- The Clippy Book: https://github.com/rust-lang/rust-clippy/issues
19+
- The Reference: https://github.com/rust-lang/reference/issues
20+
- The Rustonomicon: https://github.com/rust-lang/nomicon/issues
21+
- The Embedded Book: https://github.com/rust-embedded/book/issues
22+
23+
All other documentation issues should be filed here.
24+
25+
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
26+
1127
-->
1228

1329
### Location
1430

1531
### Summary
16-

0 commit comments

Comments
 (0)