mirror of
https://github.com/rust-lang/rust.git
synced 2025-09-26 20:21:59 +00:00
a59842e4d5
rustdoc has its own issue template now, mention that. swap the order of the last two sentances so it reads more like a typical if/else chain (base case listed last). adjust some labels and descriptions
39 lines
1.5 KiB
YAML
39 lines
1.5 KiB
YAML
name: Documentation problem
|
|
description: Report an issue with documentation content.
|
|
labels: ["A-docs"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
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)
|
|
|
|
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the rustdoc issue template instead.
|
|
|
|
All other documentation issues should be filed here.
|
|
|
|
- type: textarea
|
|
id: location
|
|
attributes:
|
|
label: Location (URL)
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: summary
|
|
attributes:
|
|
label: Summary
|
|
validations:
|
|
required: true
|