Piik/docs/README.md

Documentation Map

Start with project memory, status, and TODO. Read only the product, decision, evidence, or operations file needed for the current task.

Current Product

• Rooms and access
• Routing and transport
• Capture, audio, and media quality
• Presentation and lifecycle

These four modules own current product behavior. Source code and tests own ordinary implementation and UI detail.

Current Indexes And Operations

• Project memory: compact cross-domain map and invariants.
• Status: exact current source, production, milestone, and holds.
• TODO: the only current work ledger.
• Verification: open physical evidence and expensive gate applicability.
• Deployment: immutable application release and recovery.
• Self-hosting: initial services, topology, and operational verification.
• Configuration: environment, secrets, bounds, and ports.
• Maintenance: truth ownership, context, and repository lifecycle.

Decisions

• ADR-0001: initial P2P-first baseline.
• ADR-0002: room authority and optional SQLite stability.
• ADR-0004: Browser relay experiment.
• ADR-0005: current automatic route and SFU resource model.
• ADR-0006: historical native sender canary evidence (superseded by ADR-0010).
• ADR-0007: framework- owned media adaptation.
• ADR-0008: Browser/native window audio boundary.
• ADR-0009: optional connection-local NAT prediction.
• ADR-0011: Browser capture with Client encoded fanout.
• ADR-0010: cross-platform Client runtime and self-contained package boundary.
• ADR-0012: one shared Go backend core for Hosted and Client, amending part of ADR-0010.

Evidence

Routing and transport:

• WebRTC feasibility
• Browser peer relay
• Low-server-cost routes
• Advanced distribution alternatives

Media and platform:

• Realtime quality and codecs
• Browser background capture
• Browser screen audio
• Browser NAT traversal
• Browser platform output
• Historical native sender and shared encode evidence
• Native Client media
• Cross-platform Client runtime

Rooms and repository practice:

• Cross-restart room recovery
• Agent context governance

Backend structure:

• Server consolidation: Go core ownership and its acceptance checklist
• Backend audit and refactor preparation

Research records verified facts, measurements, assumptions, licenses, and remaining evidence boundaries. It does not own current product behavior or work priority.