Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 2.92 KB

File metadata and controls

55 lines (44 loc) · 2.92 KB

Documentation

Start with a new application for GitHub installation, routes, and SQLite or PostgreSQL. Check validation status before choosing a version. APIs and production readiness remain experimental.

Build an application

Task Guide
Install a pinned source version New-repository tutorial, package installation
Choose packages and understand dependencies Package design
Add handlers, streaming, middleware and a database Eio applications
Add sessions, passwords, OIDC or Lwt handlers Extensions
Make HTTP/HTTPS requests Streaming client
Run smaller examples Example catalog, Eio streaming and cancellation
Prepare a hosted application Deployment and proxy trust

Understand the contracts

Topic Reference
Framing, incremental I/O and connection state HTTP/1, engine, native adapters
Request matching and handler composition Routing, middleware
Resource ownership and cancellation Lifecycle
Admission, byte budgets and timeouts Limits
Metrics and event semantics Observations

Develop and validate

Task Guide
Set up the checkout and build API docs Development
Choose checks and interpret their scope Testing, CLI reference
Run Linux/macOS checks Local platform validation
Understand the synthetic scenario harness Harness contract
Generate, replay and minimize inputs Native fuzzing
Measure primitive costs and compare libraries Benchmarks, measurement backlog
Measure endpoints, overload and adverse clients Load testing, interop

Readiness and maintenance

Status is the current evidence summary. Release policy defines acceptance; beta scope defines publication scope. Dependency review records the reviewed versions and limits. Report vulnerabilities through SECURITY.md.

Open investigation records: profiling hang and historical fuzz timeouts. The PostgreSQL bytecode crash is recorded in status. Dependency experiments remain development research.

Archived plans and reports retain useful history. They do not supply current commands or acceptance. Keep each contract in its reference guide, commands in the development guides, and dated results in status or the archive.