mirror of
https://github.com/rust-lang/rust
synced 2024-09-05 16:57:03 +00:00
Add some comments to the docs issue template to clarify
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
This commit is contained in:
parent
2f320a224e
commit
e29ab16d96
17
.github/ISSUE_TEMPLATE/documentation.md
vendored
17
.github/ISSUE_TEMPLATE/documentation.md
vendored
|
@ -4,13 +4,28 @@ about: Create a report for a documentation problem.
|
|||
labels: A-docs
|
||||
---
|
||||
<!--
|
||||
|
||||
Thank you for finding a documentation problem! 📚
|
||||
|
||||
Documentation problems might be grammatical issues, typos, or unclear wording, please provide details regarding the documentation including where it is present.
|
||||
|
||||
Note: If your issue is for one of these, please use their dedicated issue tracker instead:
|
||||
|
||||
- The Rust Book: https://github.com/rust-lang/book/issues
|
||||
- Rust by Example: https://github.com/rust-lang/rust-by-example/issues
|
||||
- The Edition Guide: https://github.com/rust-lang/edition-guide/issues
|
||||
- The Cargo Book: https://github.com/rust-lang/cargo/issues
|
||||
- The Clippy Book: https://github.com/rust-lang/rust-clippy/issues
|
||||
- The Reference: https://github.com/rust-lang/reference/issues
|
||||
- The Rustonomicon: https://github.com/rust-lang/nomicon/issues
|
||||
- The Embedded Book: https://github.com/rust-embedded/book/issues
|
||||
|
||||
All other documentation issues should be filed here.
|
||||
|
||||
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
|
||||
|
||||
-->
|
||||
|
||||
### Location
|
||||
|
||||
### Summary
|
||||
|
||||
|
|
Loading…
Reference in a new issue