Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
name: 📚 Documentation
about: Improve documentation, tutorials, or educational content
title: '[DOCS] '
labels: 'documentation, good-first-issue'
assignees: ''

---

# 📚 Documentation Issue

## 📋 Documentation Type
- [ ] 📖 README improvements
- [ ] 🎓 Tutorial/Guide creation
- [ ] 📝 Code documentation (JSDoc)
- [ ] 🔧 Setup/Installation guide
- [ ] 🎯 Algorithm explanations
- [ ] 🌐 API documentation
- [ ] 🎨 UI/UX documentation
- [ ] 🧪 Testing documentation
- [ ] 🚀 Deployment guide
- [ ] ❓ FAQ section

## 🔍 Current State
**What documentation is missing or needs improvement?**
Describe the current state of documentation and what specific areas need attention.

**Target Audience:**
- [ ] 👨‍🎓 New contributors
- [ ] 👩‍💻 Developers
- [ ] 👨‍🏫 Educators
- [ ] 👩‍🎓 Students
- [ ] 🌍 End users

## 💡 Proposed Improvements
**What should be documented?**
- [ ] Step-by-step instructions
- [ ] Code examples
- [ ] Screenshots/diagrams
- [ ] Video tutorials
- [ ] Interactive examples
- [ ] Troubleshooting guide
- [ ] Best practices
- [ ] Performance tips

**Content Structure:**
1. [Section 1: Overview/Introduction]
2. [Section 2: Main content]
3. [Section 3: Examples]
4. [Section 4: Advanced topics]

## 🎯 Participation Information
- [ ] I'm participating in Social Summer of Code (SSOC) Season 4
- [ ] I'm willing to work on this documentation

<!--
The following section will only be shown if you're participating in SSOC Season 4.
Please fill this out if you checked the SSOC participation box above.
-->

<details>
<summary>🏆 SSOC Season 4 Details (Click to expand if participating in SSOC)</summary>

### SSOC Information
**Difficulty Level:**
- [ ] 🟢 Beginner (20 points) - Basic documentation, README updates
- [ ] 🟡 Intermediate (30 points) - Comprehensive guides, tutorials
- [ ] 🔴 Advanced (40 points) - Technical documentation, API docs

**Estimated Time:** [e.g., 1-2 days, 3-5 days, 1 week]

**Skills Required:**
- [ ] Technical writing
- [ ] Markdown
- [ ] Algorithm knowledge
- [ ] React/JavaScript (for code docs)
- [ ] Design (for diagrams/screenshots)
- [ ] Video editing (for tutorials)

**Documentation Plan:**
- **Research Phase**: [Gathering information and requirements]
- **Writing Phase**: [Creating content and examples]
- **Review Phase**: [Proofreading and technical accuracy]
- **Polish Phase**: [Final formatting and publication]

**Mentorship:**
- [ ] I can provide guidance for this documentation
- [ ] I need mentorship for this documentation
- [ ] This can be completed independently

</details>

## 📚 Additional Context
**References:**
- Existing documentation: [links]
- Similar projects: [examples]
- Style guides: [if any]

**Success Criteria:**
- [ ] Clear and concise writing
- [ ] Proper formatting and structure
- [ ] Accurate technical information
- [ ] Helpful examples and screenshots
- [ ] Accessible to target audience

## ✅ Checklist
- [ ] I have identified the specific documentation gap
- [ ] I have considered the target audience
- [ ] I have outlined the proposed content structure