documentation_issue.md
1 --- 2 name: Documentation Issue 3 about: Report missing, incorrect, or outdated documentation 4 title: '[Docs]: ' 5 labels: documentation, docs-needed, needs-triage 6 assignees: '' 7 8 --- 9 **Checklist** 10 11 Please select all that apply: 12 13 - [ ] Missing documentation 14 - [ ] Incorrect information 15 - [ ] Outdated information 16 - [ ] Unclear or confusing explanation 17 - [ ] Broken link or reference 18 - [ ] Other (please specify below) 19 20 **Documentation location** 21 22 Provide a link to the relevant documentation page(s), or describe where the issue exists if a link is not available. 23 24 - URL(s): 25 - Section / heading (if applicable): 26 27 **Description of the issue** 28 29 Clearly describe what is missing, incorrect, or out of date. Be as specific as possible. 30 31 **Expected or correct information** 32 33 Describe what the documentation should say, or what you expected to find. 34 35 **Suggested fix (optional)** 36 37 If you have a suggestion for how the documentation could be updated or improved, include it here. 38 You may also link to related issues, PRs, or external references. 39 40 **Additional context** 41 42 Add any other context, screenshots, or examples that might help us understand or resolve the issue.