Files
Piik/docs/README.md
T

4.7 KiB

Project Documentation

  • 需求理解: current product scope, priorities, constraints, and acceptance criteria.
  • 方案设计: accepted implementation design; runtime migration and validation are tracked in the current TODO ledger.
  • Project memory: durable current product and source snapshot to read at the start of future work.
  • Current status: bounded current/index snapshot of production, active milestones, decisions, blockers, and links to detail.
  • Verification status: demand-loaded ledger of current cross-cutting evidence, open proof boundaries, and expensive-test applicability.
  • Current TODO: unresolved work, active truth holds, and decisions that still require user confirmation.
  • Deployment: exact current/rollback production configuration, release operations, and transport evidence boundaries.
  • Maintenance guide: Git workflow, context hygiene, document lifecycle, research policy, and automation.
  • P2P WebRTC research: evidence, bandwidth model, browser constraints, reference implementations, and feasibility assessment.
  • Peer-assisted media research: browser shared-encode limits, standard relay re-encoding, deterministic sticky topology, runtime relay-capacity extension, and abandon gates.
  • Low-server-cost media routes: Host-publication/SFU distribution, selected-edge TURN, hop-level accounting, privacy-safe ICE evidence, and bounded transport gates.
  • Built-in peer ICE TURN candidate: rejected canary record, retained standards/resource findings, and the selected-edge replacement boundary.
  • Advanced peer distribution: multi-tree/SVC, encoded-object relay, native RTP forwarding, FEC/network-coding, MoQ, and measurable go/no-go gates.
  • Native shared-encode sender: consolidated Draft #16/#18/#22/#23/#25/#28 ladder, unclassified product-gate failure, staged revalidation, and stop line.
  • Native H.264 hardware decision: bounded WebCodecs no-go, proved Media Foundation/NVIDIA hardware encode, the default-fmtp 42c01f stop, and the retained interop boundary.
  • Native H.264 opt-in path: explicit H.264 sender mode, exact Pion profile registration, and one bounded Host/Viewer loopback with hardware caveats.
  • Realtime quality adaptation: correlated capture/send/receive diagnosis, production generation-rebuild gate, path-isolated dual representations, and bounded simulcast/Dynacast/SVC checks.
  • Browser screen-audio quality: capture/source compatibility, standard readback limits, Opus negotiation boundaries, and the retained no-control decision.
  • Display name and presence boundaries: browser-local storage failure behavior, Unicode normalization, control-character policy, and the Web-only presence capability boundary.
  • Agent context governance research: official Codex, Claude Code, Hermes Agent, and GitHub practices adopted by this repository.
  • ADR-0001: historical P2P-first baseline; later access and automatic-routing decisions supersede its stale current-state details.
  • ADR-0002: site access, room-scoped private Viewer grants, explicit public-watch, rotation, and minimal SQLite persistence.
  • ADR-0004: historical standard-WebRTC peer-assisted experiment and reusable evidence.
  • ADR-0005: accepted automatic P2P-first route model, capacity/accounting, fallback roles, and generation safety; runtime migration and validation remain in the current TODO.
  • ADR-0006: proposed fixed-HIGH native canary, current no-go result, and staged revalidation boundary.
  • ADR-0007: accepted path-isolated HIGH + at most one LOW policy, optional idle-layer stop, evidence contract, and SVC boundary.
  • ADR-0008: browser window-audio hint and the Windows WASAPI process-loopback boundary.

Documentation and project memory are part of the product source of truth. Update them in the same change that alters the corresponding requirement or architecture.