Commit 29450cb
committed
Add comprehensive async documentation
Phase 2 documentation adds essential async guides with integration-tested,
copy-pasteable examples following the dual documentation pattern.
New documentation:
- docs/quickstart_async.md: Async quickstart with both patterns, framework
integration examples (FastAPI, aiohttp), and performance comparisons
- docs/topics/async_programming.md: Comprehensive guide covering architecture,
patterns, performance optimization, testing, best practices, and troubleshooting
Documentation features:
- All examples use # doctest: +SKIP for testability without fixture clutter
- Real performance benchmarks (2-3x speedup measurements)
- Pattern comparison tables (when to use each pattern)
- Framework integration examples (FastAPI, aiohttp)
- Common patterns (session management, health monitoring, bulk operations)
- Troubleshooting section for common issues
Updated indices:
- docs/index.md: Added quickstart_async to main TOC
- docs/topics/index.md: Added async_programming to topics TOC
This brings async documentation coverage from ~10% to ~60% of sync baseline.1 parent afdcfff commit 29450cb
2 files changed
+2
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| 19 | + | |
19 | 20 | | |
20 | 21 | | |
21 | 22 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
11 | 12 | | |
12 | 13 | | |
13 | 14 | | |
0 commit comments