Skip to content

docs: add Mermaid architecture and protocol diagrams to README#40

Merged
faluciano merged 1 commit into
mainfrom
docs/readme-architecture-diagrams
Mar 3, 2026
Merged

docs: add Mermaid architecture and protocol diagrams to README#40
faluciano merged 1 commit into
mainfrom
docs/readme-architecture-diagrams

Conversation

@faluciano
Copy link
Copy Markdown
Owner

Summary

  • Add system architecture diagram showing TV host, phone clients, LAN connections, and package relationships
  • Add protocol sequence diagram covering the full player lifecycle: HTTP page load → WebSocket join → game loop → time sync → disconnection/session recovery
  • Update Release Flow section to reflect repository_dispatch auto-PR mechanism (replaced the old issue-based approach from PR chore: replace issue-based consumer updates with repository_dispatch auto-PR workflow #38)

Diagrams added

Diagram Shows
System Architecture TV host (HTTP + WS servers), phone clients, @couch-kit/core shared layer, LAN connections
Protocol Sequence JOIN handshake, STATE_UPDATE loop, PING/PONG time sync, disconnect recovery with 5-min timeout

No changeset needed — docs-only change, no package source code modified.

Add system architecture diagram showing TV host, phone clients,
LAN network, and package relationships. Add protocol sequence
diagram covering the full player lifecycle from HTTP page load
through WebSocket join, game loop, time sync, and session recovery.

Also update Release Flow section to reflect the repository_dispatch
auto-PR mechanism that replaced the old issue-based approach.
@faluciano faluciano merged commit f4b218c into main Mar 3, 2026
7 checks passed
@faluciano faluciano deleted the docs/readme-architecture-diagrams branch March 3, 2026 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant