diff options
| author | Yuki Okushi <jtitor@2k36.org> | 2022-07-25 22:50:16 +0900 |
|---|---|---|
| committer | Yuki Okushi <jtitor@2k36.org> | 2022-07-27 19:09:09 +0900 |
| commit | e29ab16d96074dde70e01605fdd6a23a56a7bd1d (patch) | |
| tree | 6842f3953428026b2a2a51822179d2898c6d9d85 | |
| parent | 2f320a224e827b400be25966755a621779f797cc (diff) | |
| download | rust-e29ab16d96074dde70e01605fdd6a23a56a7bd1d.tar.gz rust-e29ab16d96074dde70e01605fdd6a23a56a7bd1d.zip | |
Add some comments to the docs issue template to clarify
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
| -rw-r--r-- | .github/ISSUE_TEMPLATE/documentation.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 1d93939e233..9ccda17a6ef 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -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 - |