documentation_improvement.yml•1.15 kB
name: Documentation improvement
description: Suggest improvements or report issues in the documentation
labels: [type: documentation, needs triage]
body:
- type: textarea
id: affected-docs
attributes:
label: Affected documentation
description: Which documentation file(s) or section(s) does this relate to?
placeholder: 'e.g. README.md, docs/02-configuration.md, User Guide section on Docker'
- type: textarea
id: issue-description
attributes:
label: Describe the issue or suggestion
description: What is unclear, missing, or could be improved? Please be specific.
placeholder: 'The installation steps are missing a note about ...'
- type: textarea
id: proposed-change
attributes:
label: Proposed change or addition
description: If you have a suggestion for how to improve the documentation, please describe it here.
placeholder: 'Add a step to ... or clarify ...'
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context, links, or screenshots that might help clarify the issue or suggestion.