Skip to content

Commit 6792c9d

Browse files
authored
Merge pull request #165 from johnxie/feature/enhance-docs-content
feat: quality blitz — accuracy audit 203 tutorials + 3 new deep tutorials
2 parents 748a1bb + 131ce99 commit 6792c9d

File tree

1,235 files changed

+93831
-117519
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,235 files changed

+93831
-117519
lines changed

.continue/prompts/new-prompt.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: New prompt
3+
description: New prompt
4+
invokable: true
5+
---
6+
7+
Please write a thorough suite of unit tests for this code, making sure to cover all relevant edge cases

ENHANCEMENT_PLAN.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Documentation Enhancement Plan
2+
3+
## Current State Analysis
4+
5+
Based on CONTENT_GAPS_ANALYSIS.md:
6+
- 201 tutorials total
7+
- 198 with exactly 8 chapters
8+
- 3 with >8 chapters (n8n-mcp, langchain, ag2)
9+
- 0 with 0 chapters
10+
- 0 with partial chapter coverage
11+
12+
## Enhancement Strategy
13+
14+
### Phase 1: High-Traffic Tutorial Regeneration
15+
**Priority**: Top 10 tutorials by stars from `discoverability/tutorial-source-verification.json`
16+
17+
| Tutorial | Stars | Repo | Status |
18+
|----------|-------|------|--------|
19+
| openclaw/openclaw | 341,130 | openclaw/openclaw | Need regeneration |
20+
| facebook/react | 244,271 | facebook/react | Need regeneration |
21+
| n8n-io/n8n | 181,679 | n8n-io/n8n | Need regeneration |
22+
| ollama/ollama | 166,451 | ollama/ollama | Need regeneration |
23+
| huggingface/transformers | 158,545 | huggingface/transformers | Need regeneration |
24+
| langflow-ai/langflow | 146,399 | langflow-ai/langflow | Need regeneration |
25+
| langgenius/dify | 134,981 | langgenius/dify | Need regeneration |
26+
| anomalyco/opencode | 132,650 | anomalyco/opencode | Need regeneration |
27+
| langchain-ai/langchain | 131,599 | langchain-ai/langchain | Need regeneration |
28+
| open-webui/open-webui | 129,246 | open-webui/open-webui | Need regeneration |
29+
30+
### Phase 2: Missing High-Impact Tutorials
31+
**Priority**: Add tutorials for trending OSS projects not yet covered
32+
33+
**Candidates** (check GitHub for stars > 10K):
34+
- Vercel AI SDK (22K+ stars) - Already covered
35+
- Browser Use (85K+ stars) - Already covered
36+
- Claude Code (84K+ stars) - Already covered
37+
- Model Context Protocol servers (82K+ stars) - Already covered
38+
- Infiniflow RAGFlow (76K+ stars) - Already covered
39+
- vLLM (74K+ stars) - Already covered
40+
41+
**New additions needed**:
42+
- Check GitHub for trending repos in AI/agents space
43+
- Focus on repos with recent activity (pushed_at in last 30 days)
44+
- Target repos with documentation gaps
45+
46+
### Phase 3: Content Gap Resolution
47+
**Priority**: Fill missing code examples and depth
48+
49+
**Issues to fix**:
50+
1. Tutorials with <100 lines in chapters (already addressed in commit 5bda1be)
51+
2. Missing Mermaid diagrams in architecture chapters
52+
3. Inconsistent code example quality across tutorials
53+
4. Missing production deployment examples
54+
55+
### Phase 4: Source Code Extraction Improvements
56+
**Priority**: Enhance the regeneration script
57+
58+
**Improvements needed**:
59+
1. Better file prioritization (focus on core modules)
60+
2. Handle more file types (`.md`, `.json`, `.yaml`, `.toml`)
61+
3. Better abstraction detection for different languages
62+
4. Add test file extraction for usage examples
63+
5. Better Mermaid diagram generation from code structure
64+
65+
## Execution Plan
66+
67+
### Step 1: Regenerate High-Traffic Tutorials
68+
```bash
69+
# Run regeneration on top 10 tutorials
70+
python scripts/regenerate_tutorial_chapters.py \
71+
--slugs openclaw,facebook-react,n8n,ollama,huggingface-transformers,langflow,dify,opencode,langchain,open-webui
72+
```
73+
74+
### Step 2: Add New Tutorials
75+
1. Identify 5-10 missing high-impact repos
76+
2. Create tutorial directories with proper structure
77+
3. Add to `llms.txt` and `llms-full.txt`
78+
4. Update `discoverability/tutorial-source-verification.json`
79+
80+
### Step 3: Fix Content Gaps
81+
1. Review tutorials with low chapter counts
82+
2. Add missing code examples from source repos
83+
3. Add Mermaid diagrams where missing
84+
4. Ensure consistent production examples
85+
86+
### Step 4: Improve Source Extraction
87+
1. Update `regenerate_tutorial_chapters.py`
88+
2. Add better file filtering logic
89+
3. Enhance abstraction detection
90+
4. Add diagram generation from code structure
91+
92+
### Step 5: Quality Verification
93+
```bash
94+
# Run health checks
95+
python scripts/docs_health.py
96+
```
97+
98+
## Success Metrics
99+
100+
- [ ] All top 10 tutorials have real code examples from source repos
101+
- [ ] 5-10 new high-impact tutorials added
102+
- [ ] 0 tutorials with placeholder content
103+
- [ ] All tutorials pass docs_health.py checks
104+
- [ ] Source extraction script handles 95%+ of file types

README.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
1+
<a name="top"></a>
12
<div align="center">
23

3-
```
4-
___ ______ __ ____
5-
/ _ |_ _____ ___ ___ __ _ ___ / ____/___ ____/ /__ / __ \____ __________
6-
/ __ | |/|/ / -_|_-< / _ \/ ' \/ -_) / / / __ \/ __ / _ \ / / / / __ \/ ___/ ___/
7-
/_/ |_|__,__/\__/___/ \___/_/_/_/\__/ / /___/ /_/ / /_/ / __/ / /_/ / /_/ / /__(__ )
8-
\____/\____/\__,_/\___/ /_____/\____/\___/____/
9-
```
4+
# Awesome Code Docs
105

11-
**Deep-dive tutorials for the world's most popular open-source projects**
6+
**203 deep-dive tutorials for AI agents, LLM frameworks & coding tools**
127

138
*Learn how complex systems actually work — not just what they do*
149

1510
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
1611
[![GitHub stars](https://img.shields.io/github/stars/johnxie/awesome-code-docs?style=social)](https://github.com/johnxie/awesome-code-docs)
17-
[![Tutorials](https://img.shields.io/badge/tutorials-191-brightgreen.svg)](#-tutorial-catalog)
18-
[![Sources](https://img.shields.io/badge/source%20repos-191%2F191%20verified-brightgreen.svg)](discoverability/tutorial-source-verification.md)
12+
[![Tutorials](https://img.shields.io/badge/tutorials-203-brightgreen.svg)](#-tutorial-catalog)
13+
[![Sources](https://img.shields.io/badge/source%20repos-203%2F203%20verified-brightgreen.svg)](discoverability/tutorial-source-verification.md)
1914
[![Content Hours](https://img.shields.io/badge/content-2000%2B%20hours-orange.svg)](#-tutorial-catalog)
2015
[![Last Updated](https://img.shields.io/github/last-commit/johnxie/awesome-code-docs?label=updated)](https://github.com/johnxie/awesome-code-docs/commits/main)
2116

@@ -56,6 +51,8 @@ Every tutorial follows a consistent 8-chapter structure:
5651

5752
Each chapter includes **Mermaid architecture diagrams**, **annotated code examples** from the real codebase, and **summary tables** for quick reference.
5853

54+
[![Star History Chart](https://api.star-history.com/svg?repos=johnxie/awesome-code-docs&type=Date)](https://star-history.com/#johnxie/awesome-code-docs&Date)
55+
5956
---
6057

6158
## 🔎 Find Tutorials by Goal
@@ -66,14 +63,17 @@ Use this quick-start map if you searched for a specific outcome.
6663
|:--------------|:-----------|:-----------|
6764
| open-source vibe coding tools | [Cline](tutorials/cline-tutorial/) | [Roo Code](tutorials/roo-code-tutorial/)[OpenCode](tutorials/opencode-tutorial/)[Sweep](tutorials/sweep-tutorial/)[Tabby](tutorials/tabby-tutorial/)[Stagewise](tutorials/stagewise-tutorial/)[bolt.diy](tutorials/bolt-diy-tutorial/)[VibeSDK](tutorials/vibesdk-tutorial/)[HAPI](tutorials/hapi-tutorial/)[Kiro](tutorials/kiro-tutorial/) |
6865
| spec-driven AI delivery workflows | [OpenSpec](tutorials/openspec-tutorial/) | [Claude Task Master](tutorials/claude-task-master-tutorial/)[Codex CLI](tutorials/codex-cli-tutorial/)[OpenCode](tutorials/opencode-tutorial/)[Kiro](tutorials/kiro-tutorial/) |
69-
| build AI agents in production | [LangChain](tutorials/langchain-tutorial/) | [LangGraph](tutorials/langgraph-tutorial/)[CrewAI](tutorials/crewai-tutorial/)[OpenHands](tutorials/openhands-tutorial/)[Claude Flow](tutorials/claude-flow-tutorial/)[Devika](tutorials/devika-tutorial/)[BabyAGI](tutorials/babyagi-tutorial/) |
66+
| build AI agents in production | [LangChain](tutorials/langchain-tutorial/) | [LangGraph](tutorials/langgraph-tutorial/)[CrewAI](tutorials/crewai-tutorial/)[OpenHands](tutorials/openhands-tutorial/)[Claude Flow](tutorials/claude-flow-tutorial/)[Hermes Agent](tutorials/hermes-agent-tutorial/)[AutoAgent](tutorials/autoagent-tutorial/)[BabyAGI](tutorials/babyagi-tutorial/) |
7067
| autonomous AI software engineers | [OpenHands](tutorials/openhands-tutorial/) | [Devika](tutorials/devika-tutorial/)[SWE-agent](tutorials/swe-agent-tutorial/)[Aider](tutorials/aider-tutorial/) |
7168
| task-driven autonomous agents | [BabyAGI](tutorials/babyagi-tutorial/) | [AutoGen](tutorials/autogen-tutorial/)[CrewAI](tutorials/crewai-tutorial/)[LangGraph](tutorials/langgraph-tutorial/) |
7269
| build RAG systems | [LlamaIndex](tutorials/llamaindex-tutorial/) | [Haystack](tutorials/haystack-tutorial/)[RAGFlow](tutorials/ragflow-tutorial/) |
7370
| run LLMs locally or at scale | [Ollama](tutorials/ollama-tutorial/) | [llama.cpp](tutorials/llama-cpp-tutorial/)[vLLM](tutorials/vllm-tutorial/)[LiteLLM](tutorials/litellm-tutorial/) |
71+
| autonomous ML training experiments | [autoresearch](tutorials/autoresearch-tutorial/) | [deer-flow](tutorials/deer-flow-tutorial/)[Agno](tutorials/agno-tutorial/) |
7472
| build AI apps with TypeScript/Next.js | [Vercel AI SDK](tutorials/vercel-ai-tutorial/) | [CopilotKit](tutorials/copilotkit-tutorial/)[LobeChat](tutorials/lobechat-tutorial/) |
7573
| taskade ai / genesis / mcp workflows | [Taskade](tutorials/taskade-tutorial/) | [Taskade Docs](tutorials/taskade-docs-tutorial/)[Taskade MCP](tutorials/taskade-mcp-tutorial/)[Taskade Awesome Vibe Coding](tutorials/taskade-awesome-vibe-coding-tutorial/)[MCP Servers](tutorials/mcp-servers-tutorial/) |
76-
| build MCP tools and integrations | [MCP Python SDK](tutorials/mcp-python-sdk-tutorial/) | [FastMCP](tutorials/fastmcp-tutorial/) → [MCP Servers](tutorials/mcp-servers-tutorial/) → [MCP Quickstart Resources](tutorials/mcp-quickstart-resources-tutorial/) → [Create Python Server](tutorials/create-python-server-tutorial/) → [MCP Docs Repo](tutorials/mcp-docs-repo-tutorial/) → [Create TypeScript Server](tutorials/create-typescript-server-tutorial/) → [Awesome MCP Servers](tutorials/awesome-mcp-servers-tutorial/) → [Composio](tutorials/composio-tutorial/) → [Daytona](tutorials/daytona-tutorial/) → [GenAI Toolbox](tutorials/genai-toolbox-tutorial/) → [awslabs/mcp](tutorials/awslabs-mcp-tutorial/) → [MCP Inspector](tutorials/mcp-inspector-tutorial/) → [MCP Registry](tutorials/mcp-registry-tutorial/) → [MCP Specification](tutorials/mcp-specification-tutorial/) → [MCP TypeScript SDK](tutorials/mcp-typescript-sdk-tutorial/) → [MCP Go SDK](tutorials/mcp-go-sdk-tutorial/) → [MCP Rust SDK](tutorials/mcp-rust-sdk-tutorial/) → [MCP Java SDK](tutorials/mcp-java-sdk-tutorial/) → [MCP C# SDK](tutorials/mcp-csharp-sdk-tutorial/) → [MCP Swift SDK](tutorials/mcp-swift-sdk-tutorial/) → [MCP Kotlin SDK](tutorials/mcp-kotlin-sdk-tutorial/) → [MCP Ruby SDK](tutorials/mcp-ruby-sdk-tutorial/) → [MCP PHP SDK](tutorials/mcp-php-sdk-tutorial/) → [MCP Ext Apps](tutorials/mcp-ext-apps-tutorial/) → [MCPB](tutorials/mcpb-tutorial/) → [use-mcp](tutorials/use-mcp-tutorial/) → [MCP Use](tutorials/mcp-use-tutorial/) → [MCP Chrome](tutorials/mcp-chrome-tutorial/) → [Firecrawl MCP Server](tutorials/firecrawl-mcp-server-tutorial/) |
74+
| build MCP tools and integrations | [MCP Python SDK](tutorials/mcp-python-sdk-tutorial/) | [FastMCP](tutorials/fastmcp-tutorial/)[MCP Servers](tutorials/mcp-servers-tutorial/)[Awesome MCP Servers](tutorials/awesome-mcp-servers-tutorial/)[MCP Inspector](tutorials/mcp-inspector-tutorial/)[MCP TypeScript SDK](tutorials/mcp-typescript-sdk-tutorial/)[Composio](tutorials/composio-tutorial/)[see all MCP tutorials →](#mcp-servers--integrations) |
75+
76+
<div align="right"><a href="#top">⬆ Back to top</a></div>
7777

7878
---
7979

@@ -93,23 +93,27 @@ Quick jump links:
9393
- [Search Intent Map](discoverability/search-intent-map.md)
9494
- [Category Hubs](#category-hubs)
9595

96+
<div align="right"><a href="#top">⬆ Back to top</a></div>
97+
9698
---
9799

98100
## ✅ Source Verification Status
99101

100-
All tutorial indexes were re-verified against referenced upstream GitHub repositories on **2026-03-20**:
102+
All tutorial indexes were re-verified against referenced upstream GitHub repositories on **2026-04-12**:
101103

102-
- tutorials scanned: **191**
103-
- tutorials with source repos: **191**
104+
- tutorials scanned: **203**
105+
- tutorials with source repos: **203**
104106
- tutorials with unverified source repos: **0**
105-
- unique verified source repos: **201**
107+
- unique verified source repos: **203**
106108

107109
Verification artifacts:
108110

109111
- [Tutorial Source Verification Report](discoverability/tutorial-source-verification.md)
110112
- [Tutorial Source Verification JSON](discoverability/tutorial-source-verification.json)
111113
- verification script: [`scripts/verify_tutorial_sources.py`](scripts/verify_tutorial_sources.py)
112114

115+
<div align="right"><a href="#top">⬆ Back to top</a></div>
116+
113117
---
114118

115119
## 🧬 Taskade Ecosystem Snapshot (Verified 2026-03-21)
@@ -157,7 +161,7 @@ Data source: GitHub REST API (`stargazers_count`, `pushed_at`) via `scripts/refr
157161
```
158162
╔════════════════════════════════════════════════════════════╗
159163
║ 🤖 AI & AGENTS │ 🔧 DEV TOOLS │ 🗄️ DATA │ 🎤 SPEECH ║
160-
70+ tutorials │ 46 tutorials │ 14 tutorials │ 3 tutorials ║
164+
83+ tutorials │ 50+ tutorials │ 14 tutorials │ 3 tutorials ║
161165
╚════════════════════════════════════════════════════════════╝
162166
```
163167

@@ -197,7 +201,9 @@ Build autonomous AI systems that reason, plan, and collaborate.
197201
| **[BabyAGI](tutorials/babyagi-tutorial/)** | 18K+ | Python | Task-driven autonomous agent patterns, memory, and BabyAGI 2o/3 evolution |
198202
| **[AgenticSeek](tutorials/agenticseek-tutorial/)** | 25.4K+ | Python | Local-first autonomous agent with multi-agent planning, browsing, and coding workflows |
199203
| **[Agno](tutorials/agno-tutorial/)** | 38.3K+ | Python | Multi-agent systems with memory, orchestration, and AgentOS runtime |
200-
| **[AutoAgent](tutorials/autoagent-tutorial/)** | 8.6K+ | Python | Zero-code agent creation through natural-language workflows |
204+
| **[AutoAgent](tutorials/autoagent-tutorial/)** | 9.1K+ | Python | Zero-code agent creation through natural-language workflows and self-developing pipelines |
205+
| **[autoresearch](tutorials/autoresearch-tutorial/)** | 71K+ | Python | AI agent that autonomously runs ML training experiments overnight, optimizing val_bpb on a single GPU |
206+
| **[Hermes Agent](tutorials/hermes-agent-tutorial/)** | 66K+ | Python | Self-hosted personal AI successor to OpenClaw — multi-platform, skill learning, RL trajectory generation |
201207
| **[ADK Python](tutorials/adk-python-tutorial/)** | 18.1K+ | Python | Production-grade agent engineering with Google's Agent Development Kit |
202208
| **[Qwen-Agent](tutorials/qwen-agent-tutorial/)** | 13.5K+ | Python | Tool-enabled agent framework with MCP, RAG, and multi-modal workflows |
203209
| **[Strands Agents](tutorials/strands-agents-tutorial/)** | 5.2K+ | Python | Model-driven agents with native MCP, hooks, and deployment patterns |
@@ -458,6 +464,8 @@ Voice recognition, audio processing, and multimodal AI applications.
458464
| **[Whisper.cpp](tutorials/whisper-cpp-tutorial/)** | 37K+ | C++ | Speech recognition on edge devices |
459465
| **[OpenAI Realtime Agents](tutorials/openai-realtime-agents-tutorial/)** | 6.7K+ | TypeScript | Voice-first AI agents with WebRTC |
460466

467+
<div align="right"><a href="#top">⬆ Back to top</a></div>
468+
461469
---
462470

463471
## 🗺️ Learning Paths
@@ -594,6 +602,8 @@ Dyad ──→ bolt.diy ──→ Stagewise ──→ Cline ──→ Roo Code
594602

595603
**Duration:** 35-50 hours | **Difficulty:** Intermediate to Advanced
596604

605+
<div align="right"><a href="#top">⬆ Back to top</a></div>
606+
597607
---
598608

599609
## 📊 Collection Stats
@@ -602,9 +612,9 @@ Dyad ──→ bolt.diy ──→ Stagewise ──→ Cline ──→ Roo Code
602612
╔══════════════════════════════════════════════════════════╗
603613
║ COLLECTION OVERVIEW ║
604614
╠══════════════════════════════════════════════════════════╣
605-
║ 📦 Total Tutorials 191
606-
║ 📝 Numbered Chapters 1,528+ ║
607-
║ 📏 Tutorial Markdown 1,048,763 lines ║
615+
║ 📦 Total Tutorials 203
616+
║ 📝 Numbered Chapters 1,624+ ║
617+
║ 📏 Tutorial Markdown 706,049 lines
608618
║ ⏱️ Estimated Hours 2,000+ ║
609619
║ ✅ Local Broken Links 0 ║
610620
║ 🧭 Structure Drift 0 (all root canonical) ║
@@ -616,6 +626,8 @@ Stats are synchronized against:
616626
- `tutorials/tutorial-manifest.json`
617627
- `scripts/docs_health.py` baseline checks
618628

629+
<div align="right"><a href="#top">⬆ Back to top</a></div>
630+
619631
---
620632

621633
## 🛠️ How Tutorials Are Built
@@ -642,6 +654,8 @@ Inspired by [Tutorial-Codebase-Knowledge](https://github.com/The-Pocket/Tutorial
642654
| **[Claude Code](https://claude.ai)** | Codebase analysis and tutorial writing |
643655
| **[GitHub Pages](https://pages.github.com)** | Tutorial hosting with Jekyll |
644656

657+
<div align="right"><a href="#top">⬆ Back to top</a></div>
658+
645659
---
646660

647661
## 🤝 Contributing
@@ -670,6 +684,8 @@ We welcome contributions! Here's how you can help:
670684

671685
**[Open an Issue](https://github.com/johnxie/awesome-code-docs/issues/new)** to suggest a new tutorial or report a problem.
672686

687+
<div align="right"><a href="#top">⬆ Back to top</a></div>
688+
673689
---
674690

675691
## 🌍 Community

discoverability/query-hub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Auto-generated high-intent query landing surface mapped to the most relevant tutorials.
44

5-
- Total tutorials indexed: **201**
5+
- Total tutorials indexed: **203**
66
- Query hubs: **6**
77
- Source: `scripts/generate_discoverability_assets.py`
88

0 commit comments

Comments
 (0)