Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 3.97 KB

File metadata and controls

83 lines (60 loc) · 3.97 KB

Fitz Documentation

Fitz is a layered broker with async transports and a sync runtime core. This documentation is organized so evaluators, contributors, and operators can follow predictable reading paths.

What To Read Before Trying Fitz

  1. development/storage-invariants.md
  2. development/architecture.md
  3. user-guides/durability.md
  4. development/recovery-internals.md
  5. development/testing.md

These documents define behavior guarantees, implementation boundaries, and how those guarantees are tested.

For the hard review gate that decides whether a change preserves Fitz as a runtime of narrow primitives, read development/architectural-laws.md.

For the authoritative internal contract on domain responsibilities, overlap prevention, and feature placement, read development/domain-boundaries-spec.md.

For a short durability contract page, read user-guides/transaction-durability-contract.md.

Documentation Structure

  • user-guides/ for API and operator-facing usage
  • operations/ for deployment, runbook, and tuning
  • development/ for architecture, invariants, recovery, and release policy
  • benchmarks/ for benchmark references and future reports
  • clients/ for client wire protocol and implementation guidance
  • admin/ for admin API and operator controls

Recommended Reading Paths

Evaluating Fitz

  1. development/storage-invariants.md
  2. development/architecture.md
  3. development/architectural-laws.md
  4. user-guides/durability.md
  5. development/recovery-internals.md
  6. development/testing.md

Contributing To Runtime Correctness

  1. development/architecture.md
  2. development/architectural-laws.md
  3. development/domain-boundaries-spec.md
  4. development/route-design.md
  5. development/storage-invariants.md
  6. development/recovery-internals.md
  7. development/testing.md

General Usage

  1. user-guides/overview.md
  2. user-guides/quick-start.md
  3. user-guides/api-guide.md
  4. user-guides/troubleshooting.md

Important Positioning

  • Experimental: yes
  • Durability-tested: yes
  • Safe enough for careful evaluation: yes
  • Production-ready: not yet

See development/stability-policy.md for pre-1.0 compatibility boundaries.

What To Read Before Calling It Production-Ready

  1. development/one-dot-zero-contract.md
  2. development/one-dot-zero-readiness-scorecard.md
  3. development/support-matrix.md
  4. development/format-compatibility.md
  5. development/release-policy.md
  6. operations/production-runbook.md
  7. operations/release-checklist.md

Fitz-Specific Companion Docs