Skip to content

Latest commit

 

History

History
61 lines (52 loc) · 4.49 KB

File metadata and controls

61 lines (52 loc) · 4.49 KB

Documentation

This directory explains the product as a browser client, how to work on it, and why its durable boundaries exist. Start with the shortest document that answers your question.

Use and operate

Document Purpose
Getting started Connect, choose a Workspace, start a Session, or use the fixture.
Product scope Supported workflows, product principles, and explicit non-goals.
Deployment contract Build identity, hosting, security headers, health, and rollback.
Troubleshooting Connection, recovery, onboarding, and command diagnostics.
Security policy Supported versions and private vulnerability reporting.

Understand and change

Document Purpose
Architecture Runtime ownership, dependency direction, state, and extension boundaries.
Protocol integration Capability negotiation, projections, Core pins, and compatibility gates.
ADR index Accepted decisions, grouped by concern.
Product shell ADR Authentication, Workspace/Session navigation, and controls.
Session navigation ADR Confirmed Session refs and background turn ownership.
Contributing Development workflow and review expectations.
Testing Unit, browser, contract, runtime, and deployment verification.
Releasing Immutable publication, provenance, and rollback procedure.
Agent guide Non-negotiable repository rules for coding agents.

Project records

Documentation conventions

  • Guides describe the current system. Update them in the same change as the behavior they document.
  • ADRs record durable decisions and rejected alternatives. Do not rewrite an accepted decision to make history look current; supersede it with a new ADR.
  • Machine-readable compatibility truth belongs in packages/client/contract-source.json and packages/client/core-runtime.json, not in prose version claims.
  • Security-sensitive examples must not contain real tokens, API keys, private repository paths, or credential-bearing WebSocket URLs.