Skip to content

Commit 896d74f

Browse files
hawkeyexlhawkeyexl
committed
Refactor issue templates for improved clarity and consistency
- Change 'about' to 'description' in documentation bug, feature, and question templates. - Update body structure to include clear labels and descriptions for each input field. - Enhance user guidance with descriptive placeholders and validation requirements.
1 parent 7bf90d1 commit 896d74f

File tree

3 files changed

+181
-108
lines changed

3 files changed

+181
-108
lines changed

‎.github/ISSUE_TEMPLATE/documentation-bug.yml‎

Lines changed: 79 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,83 @@
1-
---
21
name: Documentation Bug Report
3-
about: Report an error, outdated information, or broken link in the documentation
2+
description: Report an error, outdated information, or broken link in the documentation
43
title: '[Docs Bug] '
54
labels: ['documentation', 'bug']
65
assignees: []
7-
---
8-
9-
## Page or section affected
10-
11-
<!-- Provide the URL or path to the documentation page with the issue -->
12-
URL:
13-
14-
## What's wrong?
15-
16-
<!-- Describe the issue clearly. What's incorrect, missing, or broken? -->
17-
18-
## What should it say instead?
19-
20-
<!-- If you know what the correct information should be, describe it here -->
21-
22-
## Steps to reproduce (if applicable)
23-
24-
<!-- If this is about a procedure that doesn't work, list the steps you followed -->
25-
26-
1.
27-
2.
28-
3.
29-
30-
## Expected result
31-
32-
<!-- What did you expect to happen or see? -->
33-
34-
## Actual result
35-
36-
<!-- What actually happened or what did you see? -->
37-
38-
## Screenshots (optional)
39-
40-
<!-- Add screenshots to help explain the problem -->
41-
42-
## Additional context
43-
44-
<!-- Any other information that might be helpful -->
45-
46-
## Are you willing to fix this?
47-
48-
<!-- Would you like to submit a pull request to fix this issue? -->
49-
- [ ] Yes, I can fix this
50-
- [ ] No, but I can provide more information if needed
6+
body:
7+
- type: input
8+
id: url
9+
attributes:
10+
label: Page or section affected
11+
description: Provide the URL or path to the documentation page with the issue
12+
placeholder: 'https://doc-detective.com/docs/...'
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: whats-wrong
18+
attributes:
19+
label: What's wrong?
20+
description: Describe the issue clearly. What's incorrect, missing, or broken?
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: should-say
26+
attributes:
27+
label: What should it say instead?
28+
description: If you know what the correct information should be, describe it here
29+
validations:
30+
required: false
31+
32+
- type: textarea
33+
id: steps-to-reproduce
34+
attributes:
35+
label: Steps to reproduce (if applicable)
36+
description: If this is about a procedure that doesn't work, list the steps you followed
37+
placeholder: |
38+
1.
39+
2.
40+
3.
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: expected-result
46+
attributes:
47+
label: Expected result
48+
description: What did you expect to happen or see?
49+
validations:
50+
required: false
51+
52+
- type: textarea
53+
id: actual-result
54+
attributes:
55+
label: Actual result
56+
description: What actually happened or what did you see?
57+
validations:
58+
required: false
59+
60+
- type: textarea
61+
id: screenshots
62+
attributes:
63+
label: Screenshots (optional)
64+
description: Add screenshots to help explain the problem
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: additional-context
70+
attributes:
71+
label: Additional context
72+
description: Any other information that might be helpful
73+
validations:
74+
required: false
75+
76+
- type: checkboxes
77+
id: willing-to-fix
78+
attributes:
79+
label: Are you willing to fix this?
80+
description: Would you like to submit a pull request to fix this issue?
81+
options:
82+
- label: Yes, I can fix this
83+
- label: No, but I can provide more information if needed

‎.github/ISSUE_TEMPLATE/documentation-feature.yml‎

Lines changed: 59 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,63 @@
1-
---
21
name: Documentation Feature Request
3-
about: Suggest new documentation or improvements to existing content
2+
description: Suggest new documentation or improvements to existing content
43
title: '[Docs Feature] '
54
labels: ['documentation', 'enhancement']
65
assignees: []
7-
---
8-
9-
## What documentation is missing or needs improvement?
10-
11-
<!-- Describe what documentation you'd like to see added or improved -->
12-
13-
## Who would benefit from this?
14-
15-
<!-- Describe the audience and use case -->
16-
17-
## Describe the documentation you'd like
18-
19-
<!-- What should this documentation cover? Be as specific as possible -->
20-
21-
## Suggested structure or outline (optional)
22-
23-
<!-- If you have ideas about how this documentation should be organized, share them here -->
24-
25-
## Examples from other projects (optional)
26-
27-
<!-- Link to similar documentation from other projects that you find helpful -->
28-
29-
## Additional context
30-
31-
<!-- Any other information that would help us understand your request -->
32-
33-
## Are you willing to write this?
34-
35-
<!-- Would you like to submit a pull request to add this documentation? -->
36-
- [ ] Yes, I can write this documentation
37-
- [ ] No, but I can review/provide feedback on drafts
38-
- [ ] No, I'm requesting that someone else write it
6+
body:
7+
- type: textarea
8+
id: what-is-missing
9+
attributes:
10+
label: What documentation is missing or needs improvement?
11+
description: Describe what documentation you'd like to see added or improved
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: who-benefits
17+
attributes:
18+
label: Who would benefit from this?
19+
description: Describe the audience and use case
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: describe-docs
25+
attributes:
26+
label: Describe the documentation you'd like
27+
description: What should this documentation cover? Be as specific as possible
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: suggested-structure
33+
attributes:
34+
label: Suggested structure or outline (optional)
35+
description: If you have ideas about how this documentation should be organized, share them here
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: examples
41+
attributes:
42+
label: Examples from other projects (optional)
43+
description: Link to similar documentation from other projects that you find helpful
44+
validations:
45+
required: false
46+
47+
- type: textarea
48+
id: additional-context
49+
attributes:
50+
label: Additional context
51+
description: Any other information that would help us understand your request
52+
validations:
53+
required: false
54+
55+
- type: checkboxes
56+
id: willing-to-write
57+
attributes:
58+
label: Are you willing to write this?
59+
description: Would you like to submit a pull request to add this documentation?
60+
options:
61+
- label: Yes, I can write this documentation
62+
- label: No, but I can review/provide feedback on drafts
63+
- label: No, I'm requesting that someone else write it

‎.github/ISSUE_TEMPLATE/documentation-question.yml‎

Lines changed: 43 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,47 @@
1-
---
21
name: Documentation Question
3-
about: Ask a question about the documentation
2+
description: Ask a question about the documentation
43
title: '[Docs Question] '
54
labels: ['documentation', 'question']
65
assignees: []
7-
---
8-
9-
## Your question
10-
11-
<!-- What would you like to know? -->
12-
13-
## What have you tried?
14-
15-
<!-- What documentation have you already read? What did you try? -->
16-
17-
## Context
18-
19-
<!-- Why do you need this information? What are you trying to accomplish? -->
20-
21-
## Additional information
22-
23-
<!-- Any other details that might be relevant -->
24-
25-
---
26-
27-
**Note:** For general questions about using Doc Detective, please consider:
28-
- Joining our [Discord community](https://discord.gg/2M7wXEThfF)
29-
- Checking the [documentation](https://doc-detective.com/docs)
30-
- Searching existing [issues](https://github.com/doc-detective/doc-detective.github.io/issues)
31-
32-
Use this issue template if you have a specific question about the documentation itself (not about using Doc Detective).
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
**Note:** For general questions about using Doc Detective, please consider:
11+
- Joining our [Discord community](https://discord.gg/2M7wXEThfF)
12+
- Checking the [documentation](https://doc-detective.com/docs)
13+
- Searching existing [issues](https://github.com/doc-detective/doc-detective.github.io/issues)
14+
15+
Use this issue template if you have a specific question about the documentation itself (not about using Doc Detective).
16+
17+
- type: textarea
18+
id: question
19+
attributes:
20+
label: Your question
21+
description: What would you like to know?
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: what-tried
27+
attributes:
28+
label: What have you tried?
29+
description: What documentation have you already read? What did you try?
30+
validations:
31+
required: false
32+
33+
- type: textarea
34+
id: context
35+
attributes:
36+
label: Context
37+
description: Why do you need this information? What are you trying to accomplish?
38+
validations:
39+
required: false
40+
41+
- type: textarea
42+
id: additional-info
43+
attributes:
44+
label: Additional information
45+
description: Any other details that might be relevant
46+
validations:
47+
required: false

0 commit comments

Comments
 (0)