Status icons and a sync-state inspector #41

New issue

Closed

opened 2026-09-21 18:03:01 +01:00 by cruelacid · 1 comment

cruelacid commented

2026-09-21 18:03:01 +01:00

Owner

Part of #37.

What Relay does

Per-file status icons with documented meanings — a coloured stack for
keystroke-level tracking into the local CRDT store, grey when tracking is broken,
a coloured satellite for syncing to the server, grey or absent when
disconnected, and a warning icon on links pointing outside the shared folder.
Plus a note-state inspector and a sync-state inspector behind debug flags.
(docs.relay.md/user-interface/icons/, read 21 Sep 2026.)

What we do today

One status-bar item (main.ts:3695) carrying connection state for the whole
plugin, and folder-indicator.ts marking shared folders in the explorer. There
is no per-file signal at all, so "is this note syncing?" has no answer short of
the diagnostic log.

What changes

A per-file indicator driven by the state ContentSync already tracks, and an
inspector pane that reports what the plugin believes about a document. CLAUDE.md
is explicit that instrumenting beats theorising — the diagnostic log exists for
exactly this, and an inspector is the same idea with a UI.

Risk

risk:none.

Verification

The inspector's claims are checked against an API that can actually observe the
thing, not against the plugin's own optimism.

Part of #37. ## What Relay does Per-file status icons with documented meanings — a coloured *stack* for keystroke-level tracking into the local CRDT store, grey when tracking is broken, a coloured *satellite* for syncing to the server, grey or absent when disconnected, and a warning icon on links pointing outside the shared folder. Plus a note-state inspector and a sync-state inspector behind debug flags. (`docs.relay.md/user-interface/icons/`, read 21 Sep 2026.) ## What we do today One status-bar item (`main.ts:3695`) carrying connection state for the whole plugin, and `folder-indicator.ts` marking shared folders in the explorer. There is no per-file signal at all, so "is *this* note syncing?" has no answer short of the diagnostic log. ## What changes A per-file indicator driven by the state ContentSync already tracks, and an inspector pane that reports what the plugin believes about a document. `CLAUDE.md` is explicit that instrumenting beats theorising — the diagnostic log exists for exactly this, and an inspector is the same idea with a UI. ## Risk `risk:none`. ## Verification The inspector's claims are checked against an API that can actually observe the thing, not against the plugin's own optimism.

cruelacid added this to the Phase 16 - The plugin becomes a plugin milestone

2026-09-21 18:03:01 +01:00

cruelacid added the

labels

2026-09-21 18:03:01 +01:00

cruelacid referenced this issue

2026-09-21 18:08:51 +01:00

Relay feature parity, with end-to-end encryption (tracking) #37