documentation_issue.md•1.65 kB
---
name: 📚 Documentation Issue
about: Report issues with documentation or suggest improvements
description: |
Use this template to report documentation problems, suggest improvements,
or request additional documentation content.
labels: ["documentation"]
---
## Documentation Issue
**Describe the documentation issue or improvement needed:**
## Location
**Where is this documentation located?**
- [ ] README.md
- [ ] CONTRIBUTING.md
- [ ] API Documentation
- [ ] Tutorials
- [ ] How-To Guides
- [ ] Reference
- [ ] Explanation
- [ ] Other: _________________
**Specific file(s) and section(s)**:
## Problem Description
**What's wrong with the current documentation?**
- [ ] Missing information
- [ ] Outdated information
- [ ] Incorrect information
- [ ] Poor organization/structure
- [ ] Broken links
- [ ] Typos/grammar issues
- [ ] Lack of examples
- [ ] Other: _________________
## Suggested Improvement
**How should the documentation be improved?**
## Examples
**Provide examples of how the documentation should look:**
```markdown
# Improved documentation example
This is how the documentation could be improved...
```
## Additional Context
Add any other context, screenshots, or references that might help improve the documentation.
## Related Content
List any related documentation pages or content that might be affected.
## Priority
- [ ] Low (cosmetic issue)
- [ ] Medium (confusing but workable)
- [ ] High (misleading or blocking)
## Would you be willing to contribute this improvement?
- [ ] Yes, I can help with this
- [ ] Maybe, with some guidance
- [ ] No, but I can provide more details
- [ ] Not sure