about summary refs log tree commit diff
path: root/.github/ISSUE_TEMPLATE/documentation.yaml
blob: 4a79cd4ba97c843659b893aebfb8ffe60353e624 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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