Contributing to eventsource-py Documentation
We adhere strictly to the Diataxis documentation framework:
- Tutorials (
docs/tutorials/): Learning-oriented lessons for beginners. - How-To Guides (
docs/how-to/): Task-oriented recipes to solve real-world problems. - Reference (
docs/reference/): Information-oriented technical descriptions. - Explanation (
docs/explanation/): Understanding-oriented discussions of architecture and decisions.
Invariants
- Keep all documentation synchronized with running code.
- Run
uv run spec-ops docs buildto verify that all pages compile cleanly.