main
md 33 lines 1.08 KB
Rendered Raw
1 # Sync Components DOX
2
3 ## Purpose
4
5 - Own WebUI state synchronization status UI and store.
6
7 ## Ownership
8
9 - `sync-store.js` owns sync status state.
10 - `sync-status.html` owns sync indicator markup and the `sync-status-end`
11 extension point for connection-related controls.
12
13 ## Local Contracts
14
15 - Keep sync state compatible with WebSocket state-sync events.
16 - Apply `state_push` snapshots sequentially because WebSocket subscribers do not await async callbacks; later pushes must not race earlier full renders.
17 - A queued state push that finishes after transport loss must not overwrite the
18 `DISCONNECTED` mode or flush reconnect notifications.
19 - Avoid noisy user-facing alerts for transient sync state unless existing UX expects them.
20 - Keep the compact status cluster free of native title tooltips; interactive
21 extensions must provide accessible names directly.
22
23 ## Work Guidance
24
25 - Coordinate sync changes with WebSocket client and backend WebSocket extensions.
26
27 ## Verification
28
29 - Smoke-test connection, reconnect, and state refresh indicators after changes.
30
31 ## Child DOX Index
32
33 No child DOX files.