Welcome to the GitHub Copilot Documentation Challenge! This repository contains three increasingly difficult challenges designed to help you explore and master different documentation capabilities using GitHub Copilot, GitHub Copilot Chat, and Copilot Edits.
These challenges will take approximately 20 minutes to complete and focus on different aspects of documentation:
- Inline code documentation
- Technical documentation
- Architecture documentation
- API documentation
- User guides
- System diagrams
- Code examples
-
Challenge 1: Basic Documentation (5 minutes)
- Focus: Inline comments and basic function documentation
- Go to Challenge 1
-
Challenge 2: Technical Documentation (7 minutes)
- Focus: API documentation and technical specifications
- Go to Challenge 2
-
Challenge 3: Advanced Documentation (8 minutes)
- Focus: Architecture documentation and system design
- Go to Challenge 3
- Clone this repository
- Navigate to each challenge folder
- Read the challenge README
- Use GitHub Copilot, Copilot Chat, and Copilot Edits to complete the tasks
- Run the verification tests to check your solutions
Each challenge includes its own verification method:
- Challenge 1: Unit tests
- Challenge 2: API endpoint testing
- Challenge 3: Documentation structure validation
Run npm test in each challenge directory to verify your solution.
- Use GitHub Copilot Chat to ask questions about documentation best practices
- Experiment with Copilot Edits for bulk documentation updates
- Remember to consider different documentation audiences
- Focus on clarity and completeness
| Task Type | Recommended Copilot Feature |
|---|---|
| Writing JSDoc comments | GitHub Copilot (inline suggestions) |
| Bulk documentation updates | Copilot Edits |
| Documentation best practices | Copilot Chat |
| API documentation | Copilot Chat + Copilot (inline) |
| Diagram creation | Copilot Chat |
| Architecture decisions | Copilot Chat |
Good luck with the challenges!