Skip to content

Commit 01e0543

Browse files
authored
Create documentation.md
1 parent f35270d commit 01e0543

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
2+
```markdown
3+
---
4+
name: 📚 Documentation Issue
5+
about: Report an issue with documentation or suggest improvements
6+
title: '[DOCS] Brief documentation issue'
7+
labels: ['documentation', 'triage']
8+
assignees: ''
9+
```
10+
---
11+
12+
## 📖 Documentation Location
13+
- [ ] README.md
14+
- [ ] docs/installation.md
15+
- [ ] docs/platform_notes.md
16+
- [ ] docs/FAQ.md
17+
- [ ] Tool-specific README
18+
- [ ] CONTRIBUTING.md
19+
- [ ] Other: `[please specify]`
20+
21+
## 🐛 Issue Type
22+
- [ ] Missing documentation
23+
- [ ] Incorrect information
24+
- [ ] Outdated content
25+
- [ ] Typo/grammar error
26+
- [ ] Formatting issue
27+
- [ ] Broken links
28+
- [ ] Legal/ethical concerns
29+
30+
## 📝 Description
31+
<!-- Describe the documentation issue -->
32+
33+
### Current Content
34+
```
35+
[Paste current problematic content]
36+
```
37+
38+
### Suggested Improvement
39+
```
40+
[Paste suggested improved content]
41+
```
42+
43+
## 🔗 Additional Context
44+
<!-- Any other context about the documentation issue -->
45+
46+
## 🎯 Priority
47+
- [ ] Critical (security/legal issue)
48+
- [ ] High (major functionality missing)
49+
- [ ] Medium (improvement needed)
50+
- [ ] Low (cosmetic issue)

0 commit comments

Comments
 (0)