name: Documentation
description: Report issues with documentation or suggest improvements
title: "[Docs] "
labels: ["documentation", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for helping improve our documentation! Please provide details about the documentation issue or improvement.
- type: dropdown
id: doc-type
attributes:
label: Documentation Type
description: What type of documentation issue is this?
options:
- Error or inaccuracy in existing docs
- Missing documentation
- Unclear or confusing documentation
- Documentation improvement suggestion
- New documentation request
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Describe the documentation issue or improvement
placeholder: Describe the documentation issue...
validations:
required: true
- type: textarea
id: location
attributes:
label: Documentation Location
description: Where is this documentation located?
placeholder: |
- File: README.md, CONTRIBUTING.md, etc.
- Section: Getting Started, API Reference, etc.
- Line numbers: if applicable
validations:
required: true
- type: textarea
id: suggested-fix
attributes:
label: Suggested Fix
description: If you have a suggestion for how to fix or improve the documentation, please describe it
placeholder: Suggested improvement or fix...
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other context about the documentation issue
placeholder: Add any other context here...
- type: checkboxes
id: terms
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have searched existing issues to make sure this is not a duplicate
required: true
- label: I have checked the current documentation thoroughly
required: true
