mirror of
https://github.com/stablyai/orca.git
synced 2026-10-19 16:03:26 +00:00
Document the key reliability gaps and recommended solutions for handling runtime loss and app restart in orchestration workflows: - Treat message waits as replayable database queries with reconnect support - Close the read-before-response window via cursor/receipt protocol - Persist coordinator identity on dispatches for stable routing - Add startup reconciliation to preserve live workers and fail only definitive exits - Extend idempotency to mutations like worktree.create Recommends incremental approach: recovery semantics (I0), transport resume with replay (I1), identity-complete dispatches and startup reconciliation (I2), and durable idempotent mutations (I3). Status: Brainstorm/recommended design, not an implementation plan of record.
Durable Docs
Keep this folder for versioned reference docs that are meant to survive past a single design or implementation pass.
What Goes Here
- Stable reference material.
- Public-facing docs that are not part of the root README.
- Docs that other checked-in files link to.
- Telemetry availability notes that dashboard authors need after the original design or implementation branch is gone. See Telemetry Availability.
- Headless Linux server setup for remote
orca servehosts. See Headless Linux Server. - Feature education state, interaction tracking, and retention analytics notes that define how contextual tours are persisted and measured. See Feature Education State, Feature Discovery Interaction Tracking, and Feature Education Retention Analytics.
- New-user parallel work telemetry notes that define how the parallel-work tour and setup guide should be measured against retention. See New User Parallel Work Telemetry.
What Stays Out
Ephemeral design notes, implementation sketches, and planning docs should stay as local Markdown files under docs/. They are ignored by default so they do not get checked in accidentally.