chopin

Chopin Documentation

Reference Guides

File Description
USAGE_GUIDE.md Practical usage: routing, extractors, responses, middleware, ORM, auth
DEVELOPER_GUIDE.md In-depth API development guide from hello-world to production
BENCHMARKS.md Benchmark results and how to maximize performance
TFB_COMPLIANCE.md How to write “Realistic” and rule-compliant TFB implementations

Release Notes

File Description
releases/RELEASE_NOTES_0.5.x.md Changelog for the 0.5.x (Nocturne) series

Website

The site/ directory contains the static documentation website:

File Description
site/index.html Landing page and user manual
site/developer_guide.html Interactive developer guide
site/styles.css Shared stylesheet
site/script.js Shared JS (copy-to-clipboard, mobile nav)
site/assets/ Images and static assets