Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 4.13 KB

File metadata and controls

66 lines (54 loc) · 4.13 KB

Architecture Documentation

This section explains how the system is put together and why the main technical decisions were made.

Use it when you need more than deployment guidance but less than source-level implementation detail.

Start Here

If you want to understand... Read
The runtime architecture and component boundaries SYSTEM_ARCHITECTURE.md
The request flow through header/body filters and failure paths REQUEST_LIFECYCLE.md
How directives map to runtime branches and implementation areas CONFIG_BEHAVIOR_MAP.md
Which current surfaces are stable, experimental, internal, or must be removed before 1.0 PUBLIC_SURFACE_INVENTORY.md
The repository layout and where code lives REPOSITORY_STRUCTURE.md
How the repo-owned harness is structured and why it exists HARNESS_ARCHITECTURE.md
How repo-owned agent routing and risk overlays are organized ../harness/README.md
Why conversion lives in Rust ADR/0001-use-rust-for-conversion.md
Historical full-buffer baseline and why it was originally chosen ADR/0002-full-buffering-approach.md
Why conversion runs at the origin-near layer ADR/0003-inline-origin-near-conversion.md
Why the harness became a repo-owned system ADR/0005-repo-owned-harness.md
Why 0.6.3 E2E testing moved to a Rust-first hybrid architecture ADR/0009-rust-first-e2e-test-architecture.md
The full ADR index ADR/README.md

Design Deep Dives

Topic Read
Large-response history and active bounded streaming engine LARGE_RESPONSE_DESIGN.md
Error policy contract error-policy.md
Filter chain ordering filter-ordering.md
Header mutation inventory header-mutation-inventory.md
Inflight guard inflight-guard.md
Observability schema v2 observability-schema-v2.md
FFI ABI compatibility FFI_ABI_COMPATIBILITY.md
FFI initialization contract FFI_INITIALIZATION_CONTRACT.md
Streaming eligibility audit (0.9.2) streaming-eligibility-audit.md

Historical / Retired Architecture

Topic Read
FFI migration history (historical v0.9.1 → v0.9.2 record) FFI_MIGRATION_HISTORY.md
Streaming security check order (0.7.x verification) streaming-check-order.md
Profile field map (0.9.1 historical field inventory) profile-inventory.md
Profile system design (retired profile-system rationale) profiles.md

RFCs

RFC Title Status Target Version
RFC-0008 Streaming Conversion and Support Contract Accepted / Implemented in 0.8.0 0.8.0

Scope

  • SYSTEM_ARCHITECTURE.md explains the runtime design in product and engineering terms.
  • REQUEST_LIFECYCLE.md explains the dynamic request path and control flow.
  • CONFIG_BEHAVIOR_MAP.md maps public directives to runtime behavior.
  • PUBLIC_SURFACE_INVENTORY.md records the evidence-backed 1.0 freeze classification for directives, wire schemas, observability, and FFI.
  • REPOSITORY_STRUCTURE.md explains how the repository organizes itself.
  • HARNESS_ARCHITECTURE.md explains the repo-owned harness, its truth surfaces, and its relationship to local-only inputs.
  • docs/harness/ describes task-routing overlays and check orchestration without duplicating runtime semantics.
  • ADR/ records specific architectural decisions and their consequences.