Skip to content

armgit / Piik

Public Imported from GitHub
0

Free, open-source screen sharing for private live streams with friends. Watch together in a browser or self-host Piik. 免费开源的私密屏幕共享,支持游戏直播、一起看电影与自部署。

2.2 KB
Raw Blame

Piik standards

Current product and engineering rules live here. Start with the affected subject; the ownership map explains where each fact belongs. AGENTS.md owns task authority and Contributing owns delivery.

Subject Standard
Module responsibility, resources, interfaces and contextual consistency Engineering
Product names, terminology, Chinese/English voice and content layers Naming and copy
Room authority, invitation/password access and persistence Rooms and access
Automatic routes, capacity, P2P/SFU transitions and route operations Routing and transport
Capture, encoders, media adaptation and audio Media quality
Workflow, playback, presentation and Browser/App lifecycle Presentation and lifecycle
Evidence behind each status, indicator, overlay and notice Media status
Cast, symbols, colour, animation, tooltips and playful copy Visual language
Website, README and introduction-film composition Public introduction
Runtime settings, defaults, bounds and diagnostics Configuration
Compatibility, build identity, publication and release notes Versioning
Documentation responsibilities and updating a rule Documentation ownership

Before another implementation of a familiar concept, identify its fact, owner, scope and lifetime. Apply the existing rule, or explain the contextual difference at that rule's owner. Source schemas and focused tests own exact implementation details; standards need not repeat every field or function.

ADRs preserve decisions and supersession. Research preserves dated observations and limits. TODO owns work that remains, including accepted targets not yet implemented. A recorded target is not a claim of completed verification. User guides remain in the documentation index.