Skip to content

Commit 5c5d0cb

Browse files
authored
docs: create doc improvement request issue template
1 parent 7792807 commit 5c5d0cb

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Documentation Improvement Request
2+
description: Suggest an improvement or request a change in the documentation
3+
title: "[Docs]: "
4+
labels: [documentation]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to help with our documentation!
10+
11+
- type: input
12+
id: page
13+
attributes:
14+
label: Page
15+
description: Please provide the URL of the page or section in the documentation that needs improvement.
16+
placeholder: e.g. https://github.com/your-repo/docs/specific-page.md
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: problem-description
22+
attributes:
23+
label: Problem description
24+
description: Describe the issue or problem with the current documentation. Be as specific as possible.
25+
placeholder: e.g. The example code provided is outdated and doesn't work with the latest version.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: suggested-changes
31+
attributes:
32+
label: Suggested changes
33+
description: Describe your suggested changes or improvements to the documentation.
34+
placeholder: e.g. Update the example code to work with the latest version and add more explanation about the changes.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: additional-context
40+
attributes:
41+
label: Additional context
42+
description: Provide any additional context or resources that may help in resolving the issue.
43+
placeholder: e.g., Links to related issues, documentation, or other resources.
44+
validations:
45+
required: false

0 commit comments

Comments
 (0)