---
name: Documentation
about: Report documentation issues or suggest improvements
title: '[DOCS] '
labels: documentation
assignees: ''
---
## Documentation Location
<!-- Specify which documentation needs to be updated -->
- [ ] README.md
- [ ] API Documentation
- [ ] Configuration Guide
- [ ] Examples
- [ ] Error Handling Guide
- [ ] Contributing Guidelines
- [ ] Security Policy
- [ ] Other (please specify)
## Type of Documentation Issue
- [ ] Missing information
- [ ] Incorrect information
- [ ] Unclear explanation
- [ ] Outdated content
- [ ] Broken links
- [ ] Code examples need improvement
- [ ] Formatting issues
- [ ] Translation needed
- [ ] Other (please specify)
## Current Documentation
<!-- If applicable, quote the current documentation -->
```markdown
Current documentation text here
```
## Suggested Changes
<!-- Describe what needs to be changed or added -->
```markdown
Suggested documentation text here
```
## Additional Context
<!-- Add any additional context about the documentation issue -->
## Code Examples
<!-- If suggesting changes to code examples, provide them here -->
```typescript
// Current example
```
```typescript
// Suggested example
```
## Screenshots
<!-- If applicable, add screenshots to help explain the issue -->
## Related Issues/PRs
<!-- Link to related issues or pull requests -->
## Checklist
- [ ] I have checked that this is not a duplicate issue
- [ ] I have provided clear examples of the current and desired documentation
- [ ] I have checked that all links in my suggested changes are valid
- [ ] I have removed any sensitive information from examples
- [ ] I have followed the project's documentation style guide
- [ ] I have included all necessary context for understanding the issue
## Implementation Notes
<!-- For maintainers -->
- [ ] Documentation style consistent
- [ ] Examples tested
- [ ] Links verified
- [ ] Cross-references updated
- [ ] Navigation updated if needed
- [ ] Table of contents updated if needed