1  ---
 2  name: Documentation
 3  about: Report unclear, missing, or incorrect documentation
 4  title: "[DOCS]: "
 5  labels: 'documentation, priority: unset, triage'
 6  assignees: ''
 7  
 8  ---
 9  
10  name: Documentation
11  description: Report unclear, missing, or incorrect documentation
12  title: "[Docs]: "
13  labels: ["documentation", "triage"]
14  body:
15    - type: markdown
16      attributes:
17        value: |
18          Help us improve our documentation by reporting issues or gaps.
19  
20    - type: dropdown
21      id: type
22      attributes:
23        label: Documentation issue type
24        options:
25          - Missing (documentation doesn't exist)
26          - Incorrect (information is wrong)
27          - Unclear (confusing or hard to follow)
28          - Outdated (no longer accurate)
29          - Typo or grammar
30      validations:
31        required: true
32  
33    - type: input
34      id: location
35      attributes:
36        label: Location
37        description: Where is this documentation? (URL, file path, or section name)
38        placeholder: README.adoc, section "Installation"
39      validations:
40        required: true
41  
42    - type: textarea
43      id: description
44      attributes:
45        label: Description
46        description: What's the problem with the current documentation?
47        placeholder: Describe what's wrong or missing
48      validations:
49        required: true
50  
51    - type: textarea
52      id: suggestion
53      attributes:
54        label: Suggested improvement
55        description: How should it be fixed or improved?
56        placeholder: The documentation should say...
57      validations:
58        required: false
59  
60    - type: checkboxes
61      id: contribution
62      attributes:
63        label: Contribution
64        options:
65          - label: I would be willing to submit a PR to fix this
66            required: false