DOCS: Updated the Issue templates to YAMLs for form like issue entry
This commit is contained in:
68
.gitea/issue_template/documentation.yml
Normal file
68
.gitea/issue_template/documentation.yml
Normal file
@@ -0,0 +1,68 @@
|
||||
name: 📚 Documentation Issue
|
||||
about: Report missing, incorrect, or unclear documentation
|
||||
title: '[DOCS] '
|
||||
labels: ['documentation']
|
||||
body:
|
||||
- type: input
|
||||
id: page-url
|
||||
attributes:
|
||||
label: Documentation Page
|
||||
description: Link to the docs page with the issue.
|
||||
placeholder: 'https://docs.evercatch.dev/...'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: issue-type
|
||||
attributes:
|
||||
label: Issue Type
|
||||
options:
|
||||
- label: Missing documentation
|
||||
- label: Incorrect information
|
||||
- label: Unclear/confusing explanation
|
||||
- label: Broken link
|
||||
- label: Code example doesn't work
|
||||
- label: Typo/grammar
|
||||
- label: Outdated information
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: What's wrong with the docs?
|
||||
placeholder: The problem is...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: current
|
||||
attributes:
|
||||
label: Current Content
|
||||
description: Quote the current problematic content.
|
||||
render: markdown
|
||||
|
||||
- type: textarea
|
||||
id: suggested
|
||||
attributes:
|
||||
label: Suggested Fix
|
||||
description: How would you improve it?
|
||||
render: markdown
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Screenshots, correct information, working examples, etc.
|
||||
|
||||
- type: dropdown
|
||||
id: impact
|
||||
attributes:
|
||||
label: Impact
|
||||
description: How does this affect users?
|
||||
options:
|
||||
- Critical - Causes errors if followed
|
||||
- High - Likely to confuse users
|
||||
- Medium - Could be clearer
|
||||
- Low - Minor improvement
|
||||
validations:
|
||||
required: true
|
||||
Reference in New Issue
Block a user