1.5 KiB
1.5 KiB
| name | about | title | labels | assignees | |
|---|---|---|---|---|---|
| Documentation | Improve or add documentation | [DOCS] |
|
Documentation Issue
What documentation is missing, unclear, or needs improvement?
Location
File(s): Section/Function: Current Documentation State: [Missing/Incomplete/Unclear/Outdated]
Problem
Describe what makes the current documentation insufficient:
- Missing entirely
- Incomplete information
- Unclear explanations
- Outdated information
- Poor examples
- Hard to find
Proposed Improvement
What should be documented or how should it be improved?
Target Audience
Who is this documentation for?
- New contributors
- End users
- API developers
- System administrators
- Advanced users
Content Outline
Provide a rough outline of what should be documented: 1. 2. 3.
Examples Needed
What examples would be helpful?
Related Code
Link to relevant code files or functions that need documentation.
Additional Context
Add any other context or examples about the documentation improvement.
Priority
- High - Blocking contributor onboarding
- Medium - Important for user experience
- Low - Nice-to-have improvement
Labels to Add
Select appropriate labels:
good first issue- Perfect for newcomersapi- API documentationtesting- Test documentationcontributor-experience- For contributorsuser-guide- For end users