These docs describe the current codebase. Release history lives in
CHANGELOG.md; plans and release snapshots stay out of the maintained docs
path.
- User Guide - the single user guide for install, first project, handler API, routing, JSON, JS/TS/TSX, virtual modules, tests, deploy, proof receipts, and troubleshooting.
- CLI Reference - core commands, advanced analyzer commands, proof-ledger commands, expert mode, and machine-readable output.
- Virtual Modules - complete current
zigttp:*module list, exports, capabilities, effects, and runtime requirements. - Roadmap - one forward-looking document for supported platforms, current limitations, and planned work.
- Contracts and Auto-Sandboxing - handler
contracts, least-privilege runtime policy, OpenAPI/SDK emit, replay,
upgrade checks, and
Spec<...>. - Verification - compile-time handler checks.
- TypeScript - type stripping, type checking, TSX, and
comptime(). - TypeScript Patterns - the "TypeScript Tips Everyone Should Know" canon mapped onto the zigts subset.
- Feature Detection - allowed and rejected language features.
- Restrictions to Proofs - why each language cut exists.
- Sound Mode - type-directed truthiness, arithmetic, and comparison diagnostics.
- Canonical Profile - canonical ZigTS rules and
zigttp normalize. - Proof Card, Proof Gate, Counterexamples, and Witnesses - proof UI, pull-request gates, failing inputs, and persisted witness corpus.
- Edge Runtime - optional in-process multi-handler router.
- Performance - current benchmark claims and tuning notes.
- Reliability - limits, failure behavior, and exit codes.
- Threat Model - current trust boundaries and non-goals.
- Architecture - runtime, engine, request flow, contracts, and deploy architecture.
- Zig Embedding API - advanced Zig embedding and native function extension notes.
- Module Capabilities - built-in module capability governance.
- zigts Expert Contract - stable structured-tool output used by compiler-in-the-loop workflows.