Commit 432d914
committed
docs: Add comprehensive async documentation
Add first-class async documentation across README, quickstart, and API
reference to match sync documentation standards.
Created docs/api/async.md (comprehensive async API reference):
- Overview and when to use async methods
- Complete method documentation with usage examples
- Concurrent operations patterns
- Integration with async frameworks (FastAPI, aiohttp)
- Error handling patterns
- Performance characteristics and benchmarks
- Comparison table: sync vs async
- Implementation details (a' prefix convention)
- Roadmap positioning as foundation of async support
Updated README.md:
- Added "Async Support" section before "Python support"
- Practical example showing concurrent window creation
- List of all 5 async methods with descriptions
- Link to full async API documentation
Updated docs/quickstart.md:
- Added "Async Support" section before "Final notes"
- Basic async usage example
- Concurrent operations example with asyncio.gather()
- List of available async methods with cross-references
- When to use async guidance
Updated docs/api/index.md:
- Added 'async' to toctree after 'panes'
Updated API reference files:
- docs/api/servers.md: Added async methods section
- docs/api/sessions.md: Added async methods section
- docs/api/windows.md: Added async methods section
- All include cross-references to comprehensive async docs
Sphinx build: Succeeds with 62 warnings (pre-existing, not from changes)
This completes essential async documentation (Option B), providing:
✅ All source code docstrings enhanced
✅ README shows async exists and how to use it
✅ Quickstart teaches async patterns
✅ Comprehensive async API reference
✅ Navigation and discoverability
✅ First-class documentation parity with sync methods1 parent 5ba2e3d commit 432d914
File tree
7 files changed
+544
-0
lines changed- docs
- api
7 files changed
+544
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
246 | 246 | | |
247 | 247 | | |
248 | 248 | | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
249 | 289 | | |
250 | 290 | | |
251 | 291 | | |
| |||
0 commit comments