Help us build the world's best collection of educational technical documentation!
Every contribution makes complex systems more accessible to developers worldwide 🌍
We curate documentation that transforms understanding - going beyond "what to do" to explain "how it works" and "why it matters."
| Criterion | Description | Examples |
|---|---|---|
| 🧠 Transforms Understanding | Explains systems thinking, not just usage | Architecture deep-dives, algorithm explanations |
| 💻 Production Focus | Real codebases, not toy examples | Actual open-source project walkthroughs |
| 📊 Visual Learning | Rich diagrams and interactive elements | System diagrams, flowcharts, live demos |
| 🛠️ Hands-On Practice | Runnable code you can experiment with | Step-by-step implementations, exercises |
| 📚 Progressive Learning | Clear path from beginner to advanced | Structured chapters, prerequisite guidance |
| 🔄 Current & Maintained | Updated within the last 12 months | Modern practices, latest versions |
📖 Click to see examples of exceptional documentation
Architecture Deep-Dives:
- System design explanations with component diagrams
- Database internals with query execution analysis
- Distributed system patterns with failure scenarios
Code Walkthroughs:
- Line-by-line analysis of complex algorithms
- Production codebase architecture tours
- Performance optimization case studies
Interactive Learning:
- Jupyter notebooks with executable examples
- Browser-based coding environments
- Step-by-step tutorial with validation
- Basic "hello world" tutorials without depth
- Pure API documentation without architectural context
- Marketing content disguised as educational material
- Outdated resources (>2 years without updates)
- Content requiring paid subscriptions to access
📝 Create a New Issue with your documentation suggestion.
This is the fastest way to get your suggestion reviewed and included!
For direct contributions to the repository:
- 🍴 Fork this repository
- 📋 Add your entry using our standard format (see below)
- 🔍 Test all links to ensure they work
- 📤 Submit a pull request with a clear description
### [Documentation Title](https://example.com)
**Format Type | Difficulty Level | Time Investment**
> One compelling sentence explaining what makes this documentation transformative.
- **What You'll Learn**: Specific skills, concepts, and insights gained
- **Prerequisites**: Required background knowledge and experience level
- **Time Investment**: Realistic estimate for completion
- **Standout Feature**: What makes this documentation uniquely valuable
- **Technologies**: Primary languages, frameworks, or tools covered
**Tags**: `primary-tech` `secondary-tech` `concept-tags` `format-type`### [Building a Redis Clone from Scratch](https://build-your-own.org/redis)
**Code Walkthrough | Intermediate | 12-15 hours**
> Complete implementation guide that builds a Redis-compatible server in C, teaching fundamental database and networking concepts through hands-on coding.
- **What You'll Learn**: TCP server architecture, hash table optimization, memory management, event-driven programming, protocol design
- **Prerequisites**: Solid C programming skills, basic networking knowledge, understanding of data structures
- **Time Investment**: 12-15 hours including implementation, testing, and experimentation
- **Standout Feature**: Builds a fully functional Redis subset that passes official compatibility tests
- **Technologies**: C, TCP/IP, Hash Tables, Event Loops, Memory Management
**Tags**: `c` `redis` `databases` `networking` `systems-programming` `implementation-guide`Our community-driven review ensures only the highest quality content:
- ✅ Link accessibility and functionality
- ✅ Content quality and educational value
- ✅ Alignment with our criteria
- ✅ Proper formatting and completeness
- 👥 Community members test and evaluate
- 💬 Discussion and feedback collection
- 🔄 Suggested improvements incorporated
- 📊 Educational impact assessment
- ✅ Accept - Content meets all criteria
- 🔄 Request Changes - Minor improvements needed
- ❌ Decline - Doesn't meet criteria (with detailed feedback)
We're especially looking for documentation in these areas:
| Category | Specific Needs | Impact Level |
|---|---|---|
| 🤖 AI/ML Systems | LLM architectures, training pipelines, inference optimization | 🔥 High |
| 🌐 Web Frameworks | React internals, Vue reactivity, framework comparisons | 🔥 High |
| 🗄️ Database Internals | Query planners, storage engines, distributed consensus | 🔥 High |
| ☁️ Cloud Native | Kubernetes operators, service mesh, observability | 🔥 High |
| 🔧 Developer Tools | Language servers, build systems, debugging tools | 🟡 Medium |
| 🔐 Security | Cryptographic implementations, security analysis | 🟡 Medium |
- What complex system have you recently understood deeply?
- Which documentation transformed your understanding of a technology?
- What production codebase taught you valuable architectural patterns?
- Which tutorial made a difficult concept finally "click" for you?
| Type | Best Place | Response Time |
|---|---|---|
| General Questions | GitHub Issues | 24-48 hours |
| Specific Issues | Create an Issue | 24-48 hours |
| Quick Questions | @johnxie on Twitter | Varies |
| Collaboration Ideas | 2-3 days |
- Tutorial Template - Structure for comprehensive tutorials
- Tutorial Index Template v2 - Standard structure for chapter-track index pages
- Quality Checklist - Self-assessment guide
- PocketFlow-Inspired Index Style - Formatting and section guidance for
format_version: v2 - Existing Tutorials - Examples of our quality standards
- 🎖️ Recognition - Featured in our contributor hall of fame
- 📢 Promotion - Your contributions shared on social media
- 🤝 Network - Connect with other expert contributors
- 📈 Impact - Help thousands of developers learn complex systems
- 🎯 Expertise - Build your reputation in the developer community
| Value | Description |
|---|---|
| 🎯 Quality First | We prioritize learning impact over quantity |
| 🤝 Collaborative | Every contribution improves through community feedback |
| 🌍 Inclusive | We welcome contributors from all backgrounds and experience levels |
| 📚 Educational | Our mission is transforming complex systems into accessible knowledge |
| 🔄 Continuous Improvement | We constantly refine our processes and standards |
🎯 Ready to make complex systems more accessible?
📝 Suggest Documentation • 💬 Join the Conversation • ⭐ Star the Repo
Quality over quantity • Real-world focus • Community-driven • Always learning
Together, we're building the world's best collection of educational technical documentation! 🚀