.github/ISSUE_TEMPLATE/documentation.yaml

   1 name: Documentation problem
   2 description: Create a report for a documentation problem.
   3 labels: ["A-docs"]
   4 body:
   5   - type: markdown
   6     attributes:
   7       value: |
   8         Thank you for finding a documentation problem! 📚
   9
  10         Documentation problems might be grammatical issues, typos, or unclear wording, please provide details regarding the documentation including where it is present.
  11
  12         Note: If your issue is for one of these, please use their dedicated issue tracker instead:
  13         - [The Rust Book](https://github.com/rust-lang/book/issues)
  14         - [Rust by Example](https://github.com/rust-lang/rust-by-example/issues)
  15         - [The Edition Guide](https://github.com/rust-lang/edition-guide/issues)
  16         - [The Cargo Book](https://github.com/rust-lang/cargo/issues)
  17         - [The Clippy Book](https://github.com/rust-lang/rust-clippy/issues)
  18         - [The Reference](https://github.com/rust-lang/reference/issues)
  19         - [The Rustonomicon](https://github.com/rust-lang/nomicon/issues)
  20         - [The Embedded Book](https://github.com/rust-embedded/book/issues)
  21
  22         All other documentation issues should be filed here.
  23
  24         Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
  25
  26   - type: textarea
  27     id: location
  28     attributes:
  29       label: Location
  30     validations:
  31       required: true
  32
  33   - type: textarea
  34     id: summary
  35     attributes:
  36       label: Summary
  37     validations:
  38       required: true