Roadmap & design docs¶
tempestweb is in early construction 🚧, with a set of living design documents versioned next to the code. This page is their index — it links the originals on GitHub, which are the source of truth.
Why these docs live in the repository
They use relative links to the code and the fixtures, and change every phase. Keeping them in the repo (and not rebuilt here) guarantees they stay in sync with what was implemented.
The documents¶
-
The complete design: the "one tree, multiple renderers" idea, the two modes, and tracks N (capabilities), O (observability) and P (PWA).
-
The order of phases with a testable "done when" for each.
-
The Python↔client wire format, pinned by golden fixtures. The didactic summary is in Wire contract.
-
The canonical layers document. The didactic overview is in Architecture.
What's coming¶
The big blocks of work, all shared by both modes:
| Track | Theme | Pages here |
|---|---|---|
| N | native/ capabilities (typed Web APIs) |
Capabilities |
| O | Observability / production (adapter pattern) | Observability |
| P | PWA / offline-first / WebPush | PWA & offline |
| B5 | SSE transport (alternative to WebSocket) | Wire contract |
Documentation follows the code
As each track ships phases, the corresponding pages here move from "under construction" to complete, tested examples. The roadmap is the place to track each phase's "done when".
Recap¶
- The design docs are living and live in the repository (source of truth).
- This documentation links the originals and offers didactic summaries of the stable parts.
- Tracks N/O/P have dedicated pages here, updated as they ship.
Want to start using it? Head to the Installation and do the Tutorial. 🚀