Zayin/Signage
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 4 Wiki Activity

docs: add CLAUDE.md and mark display management as transitional

Browse Source 
Signage had no agent guidance at all. Add a CLAUDE.md that records the
standalone-module architecture, that the parent ROADMAP.md and DESIGN.md are
authoritative, the ownership, branding, token, dark-mode, no-native-dialog and
plain-language rules, that display pairing is transitional until Stage 1
Settings -> Displays, and the branch-per-PR, no-push-to-main, no-release-tag
workflow.

The README listed a mobile management UI as out of scope, which contradicts
the design contract's responsive requirement; it is a Stage 1 deferral, and
now says so alongside how displays work today.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
ekklesia
2026-10-12 21:32:04 -05:00
co-authored by Claude Opus 5.5
parent 86d49846ff
commit 6bf9167f85
2 changed files with 102 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -3
View File
@@ -139,8 +139,25 @@ description of the platform ABI.
| Transitions, offline continuation, playback controls | Dynamic change within one slide |
| The management and display UI | Its own internal multi-stage behaviour |
## Displays today, and what Stage 1 changes
Displays are platform-owned. What exists now is transitional: a screen is paired in the Dashboard
sidebar's *Display devices* panel, and Signage keeps its own roster of the screens that have checked
in — their names, the group and audience each is assigned to, and their health. A running display
follows its assignment as soon as an administrator changes it, and a revoked display returns to its
pairing code. Entries for screens that are offline (a retired television, a test tab) can be removed
from the roster.
The product roadmap moves pairing and the one global display name to the platform's
**Settings → Displays** in Stage 1; Signage will then select an existing display instead of naming its
own. Until then, existing paired displays, their viewer identities, cached content, and assignments are
preserved across every Signage upgrade.
The management screen is currently desktop-only (the narrow-screen notice below 1024 px). The product
design requires phone and tablet administration and dark mode; that arrives with the Stage 1 shared
responsive Dashboard and design system rather than as a Signage-only layout.
## Licence and scope
Deployment, the module store, a theme editor, a mobile management UI, video and audio, MQTT, Home
Assistant, Companion, and any migration of legacy Announcements data are explicitly out of scope for
this repository.
Deployment, the module store, a theme editor, video and audio, MQTT, Home Assistant, Companion, and any
migration of legacy Announcements data are explicitly out of scope for this repository.