Skip to content

Commit 5f1f162

Browse files
authored
Add documentation issue template
This new issue template helps users report documentation issues by providing structured fields for details.
1 parent 324be74 commit 5f1f162

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Documentation Issue
2+
description: Something in the docs is missing, wrong, or unclear.
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Documentation issues are always welcome — clear docs help everyone.
10+
If you already know the fix, a pull request is even better than an issue.
11+
12+
- type: input
13+
id: location
14+
attributes:
15+
label: Where is the problem?
16+
description: Link to the page, section, or file with the issue.
17+
placeholder: "e.g. README.md §Setup, https://..."
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: type
23+
attributes:
24+
label: Type of issue
25+
options:
26+
- Incorrect or outdated information
27+
- Missing information
28+
- Unclear or confusing explanation
29+
- Broken link
30+
- Typo or formatting issue
31+
- Other
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: current
37+
attributes:
38+
label: What does it currently say or show?
39+
description: Quote or describe the problematic content.
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: expected
45+
attributes:
46+
label: What should it say or show?
47+
description: Describe the correct or improved content, if you know it.
48+
validations:
49+
required: false
50+
51+
- type: textarea
52+
id: context
53+
attributes:
54+
label: Additional context
55+
description: Anything else that might help.
56+
validations:
57+
required: false

0 commit comments

Comments
 (0)