Skip to content

Commit a496c3c

Browse files
committed
docs: website + README for REST API, emergency presets, slide templates
- Landing page: two new bento cells (REST API, Slide templates, both New) linking to the API reference; Emergency override cell updated to mention one-tap presets - Roadmap: new top shipped entry for v1.0.28 (REST API, presets, templates); removed the now-shipped REST API item from In production and the now-shipped slide-templates/emergency-templates items from Planned; shipped count 9 -> 10 - API reference (docs/api.html) linked from every page's mobile menu and footer Product column - README: REST API link in the header nav, feature list updated with templates/presets/API and date-range scheduling, roadmap teaser trimmed to what's actually still open (remote display ops, native widgets, NDI) All 9 pages re-validated: HTML parses, no broken internal links or anchors, README relative links resolve.
1 parent 17fc1be commit a496c3c

9 files changed

Lines changed: 40 additions & 19 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Restaurants, churches, schools, event venues, and community spaces.<br>DisplayGr
1212
[![pnpm](https://img.shields.io/badge/pnpm-10-orange.svg)](https://pnpm.io)
1313
[![SQLite](https://img.shields.io/badge/database-SQLite-lightblue.svg)](https://sqlite.org)
1414

15-
**[Website](https://joemighty.github.io/DisplayGrid/) · [Download](https://joemighty.github.io/DisplayGrid/download.html) · [Roadmap](https://joemighty.github.io/DisplayGrid/roadmap.html) · [Guides](https://joemighty.github.io/DisplayGrid/guides/getting-started.html) · [Report a Bug](https://github.com/JoeMighty/DisplayGrid/issues)**
15+
**[Website](https://joemighty.github.io/DisplayGrid/) · [Download](https://joemighty.github.io/DisplayGrid/download.html) · [Roadmap](https://joemighty.github.io/DisplayGrid/roadmap.html) · [REST API](https://joemighty.github.io/DisplayGrid/api.html) · [Guides](https://joemighty.github.io/DisplayGrid/guides/getting-started.html) · [Report a Bug](https://github.com/JoeMighty/DisplayGrid/issues)**
1616

1717
</div>
1818

@@ -82,7 +82,8 @@ It installs Chromium, asks for your server address and screen token, and boots t
8282
## Features
8383

8484
**Content & playback**
85-
- Drag-and-drop playlist builder with per-slide durations, transitions, and day/time scheduling
85+
- Drag-and-drop playlist builder with per-slide durations, transitions, and day/time/date scheduling (e.g. "show this playlist 1–24 December")
86+
- Fillable slide templates — welcome screen, announcement, menu board, event schedule — with live preview, no design skills required
8687
- Asset library for images, videos, and PDFs with automatic WebP optimisation
8788
- Live streams: HLS (`.m3u8`) and WebRTC (WHEP) sources as slides — pair with go2rtc or MediaMTX to put IP cameras and OBS feeds on any screen
8889
- Web page, custom HTML, clock, and text slides
@@ -92,7 +93,8 @@ It installs Chromium, asks for your server address and screen token, and boots t
9293
- Multi-screen management: resolution, refresh rate, rotation, colour profile, and LED panel grids per screen
9394
- Real-time delivery — WebSocket pushes playlist changes to every display instantly
9495
- Screen health monitoring: live online/offline status, last-seen, client IP
95-
- Emergency override: broadcast a full-screen alert to every display with one click
96+
- Emergency override with one-tap presets (fire, lockdown, closure, and more) — broadcast a full-screen alert to every display instantly
97+
- REST API with token auth — trigger the emergency override or read screen/playlist status from Home Assistant, n8n, or a script ([reference](https://joemighty.github.io/DisplayGrid/api.html))
9698
- Offline resilience — displays cache their last playlist and keep playing through outages
9799

98100
**Platform**
@@ -101,7 +103,7 @@ It installs Chromium, asks for your server address and screen token, and boots t
101103
- Auto-updating apps — kiosks update silently on restart, never mid-show
102104
- Runs on Windows, macOS, Linux, Raspberry Pi, and Docker
103105

104-
See the [roadmap](https://joemighty.github.io/DisplayGrid/roadmap.html) for what's next — a documented REST API, date-range scheduling, and NDI support.
106+
See the [roadmap](https://joemighty.github.io/DisplayGrid/roadmap.html) for what's next — remote display operations, native widgets, and NDI support.
105107

106108
---
107109

docs/download.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
<a href="guides/getting-started.html">Getting Started <small>Zero to first screen</small></a>
5050
<a href="guides/hardware.html">Hardware <small>Displays, players, mounts</small></a>
5151
<a href="roadmap.html">Roadmap <small>Shipped and what’s next</small></a>
52+
<a href="api.html">API <small>REST reference</small></a>
5253
<a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub <small>Source & releases</small></a>
5354
</div>
5455

@@ -289,6 +290,7 @@ <h4>Product</h4>
289290
<ul>
290291
<li><a href="download.html">Download</a></li>
291292
<li><a href="roadmap.html">Roadmap</a></li>
293+
<li><a href="api.html">REST API</a></li>
292294
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
293295
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
294296
</ul>

docs/guides/getting-started.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
<a href="../download.html">Download <small>Apps, Docker, and source</small></a>
4949
<a href="getting-started.html">Getting Started <small>Zero to first screen</small></a>
5050
<a href="../roadmap.html">Roadmap <small>Shipped and what&rsquo;s next</small></a>
51+
<a href="../api.html">API <small>REST reference</small></a>
5152
<a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub <small>Source &amp; releases</small></a>
5253
</div>
5354

@@ -191,6 +192,7 @@ <h4>Product</h4>
191192
<ul>
192193
<li><a href="../download.html">Download</a></li>
193194
<li><a href="../roadmap.html">Roadmap</a></li>
195+
<li><a href="../api.html">REST API</a></li>
194196
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
195197
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
196198
</ul>

docs/guides/hardware.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
<a href="../download.html">Download <small>Apps, Docker, and source</small></a>
4949
<a href="getting-started.html">Getting Started <small>Zero to first screen</small></a>
5050
<a href="../roadmap.html">Roadmap <small>Shipped and what&rsquo;s next</small></a>
51+
<a href="../api.html">API <small>REST reference</small></a>
5152
<a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub <small>Source &amp; releases</small></a>
5253
</div>
5354

@@ -195,6 +196,7 @@ <h4>Product</h4>
195196
<ul>
196197
<li><a href="../download.html">Download</a></li>
197198
<li><a href="../roadmap.html">Roadmap</a></li>
199+
<li><a href="../api.html">REST API</a></li>
198200
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
199201
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
200202
</ul>

docs/guides/kiosk-setup.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
<a href="../download.html">Download <small>Apps, Docker, and source</small></a>
4949
<a href="getting-started.html">Getting Started <small>Zero to first screen</small></a>
5050
<a href="../roadmap.html">Roadmap <small>Shipped and what&rsquo;s next</small></a>
51+
<a href="../api.html">API <small>REST reference</small></a>
5152
<a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub <small>Source &amp; releases</small></a>
5253
</div>
5354

@@ -208,6 +209,7 @@ <h4>Product</h4>
208209
<ul>
209210
<li><a href="../download.html">Download</a></li>
210211
<li><a href="../roadmap.html">Roadmap</a></li>
212+
<li><a href="../api.html">REST API</a></li>
211213
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
212214
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
213215
</ul>

docs/guides/network-setup.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
<a href="../download.html">Download <small>Apps, Docker, and source</small></a>
4949
<a href="getting-started.html">Getting Started <small>Zero to first screen</small></a>
5050
<a href="../roadmap.html">Roadmap <small>Shipped and what&rsquo;s next</small></a>
51+
<a href="../api.html">API <small>REST reference</small></a>
5152
<a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub <small>Source &amp; releases</small></a>
5253
</div>
5354

@@ -304,6 +305,7 @@ <h4>Product</h4>
304305
<ul>
305306
<li><a href="../download.html">Download</a></li>
306307
<li><a href="../roadmap.html">Roadmap</a></li>
308+
<li><a href="../api.html">REST API</a></li>
307309
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
308310
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
309311
</ul>

docs/guides/raspberry-pi.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
<a href="../download.html">Download <small>Apps, Docker, and source</small></a>
4949
<a href="getting-started.html">Getting Started <small>Zero to first screen</small></a>
5050
<a href="../roadmap.html">Roadmap <small>Shipped and what&rsquo;s next</small></a>
51+
<a href="../api.html">API <small>REST reference</small></a>
5152
<a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub <small>Source &amp; releases</small></a>
5253
</div>
5354

@@ -286,6 +287,7 @@ <h4>Product</h4>
286287
<ul>
287288
<li><a href="../download.html">Download</a></li>
288289
<li><a href="../roadmap.html">Roadmap</a></li>
290+
<li><a href="../api.html">REST API</a></li>
289291
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
290292
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
291293
</ul>

docs/index.html

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
<a href="guides/getting-started.html">Getting Started <small>Zero to first screen</small></a>
5050
<a href="guides/hardware.html">Hardware <small>Displays, players, mounts</small></a>
5151
<a href="roadmap.html">Roadmap <small>Shipped and what’s next</small></a>
52+
<a href="api.html">API <small>REST reference</small></a>
5253
<a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub <small>Source & releases</small></a>
5354
</div>
5455

@@ -171,8 +172,8 @@ <h3>Screen health</h3>
171172

172173
<div class="cell rv" data-d="2"><div class="shell"><div class="core">
173174
<div class="f-icon rose"><svg width="19" height="19" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M10.29 3.86 1.82 18a2 2 0 0 0 1.71 3h16.94a2 2 0 0 0 1.71-3L13.71 3.86a2 2 0 0 0-3.42 0z"/><path d="M12 9v4M12 17h.01"/></svg></div>
174-
<h3>Emergency override</h3>
175-
<p>Broadcast a full-screen urgent message to every display with one click.</p>
175+
<h3>Emergency override <span class="badge-new">New</span></h3>
176+
<p>Broadcast a full-screen urgent message to every display with one click — or fire a one-tap preset (fire, lockdown, closure) with no typing.</p>
176177
</div></div></div>
177178

178179
<div class="cell rv" data-d="3"><div class="shell"><div class="core">
@@ -223,6 +224,18 @@ <h3>Docker <span class="badge-new">New</span></h3>
223224
<p>One container runs everything: <code style="font-family:var(--font-mono);font-size:0.82em;">docker compose up -d</code>, state in a single volume.</p>
224225
</div></div></div>
225226

227+
<div class="cell cell-6 rv"><div class="shell"><div class="core">
228+
<div class="f-icon"><svg width="19" height="19" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M18 16.98h-5.99c-1.1 0-1.95.94-2.48 1.9A4 4 0 0 1 2 17c.01-.7.2-1.4.57-2M18 17v3h4M13 6a3 3 0 0 0-3-3M5.83 21.62A8 8 0 0 1 4 17c0-4.4 3.6-8 8-8 0 0 3.5 0 5.5 2M22 8.34c0-4.7-4-8.34-9-8.34-.34 0-.68.02-1 .06"/></svg></div>
229+
<h3>REST API <span class="badge-new">New</span></h3>
230+
<p>Token-authenticated endpoints for automation — trigger the emergency override or read screen status from Home Assistant, n8n, or a cron job. <a href="api.html" style="color:#93b4ff;">See the reference</a>.</p>
231+
</div></div></div>
232+
233+
<div class="cell cell-6 rv" data-d="1"><div class="shell"><div class="core">
234+
<div class="f-icon amber"><svg width="19" height="19" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><rect x="3" y="3" width="7" height="7" rx="1"/><rect x="14" y="3" width="7" height="7" rx="1"/><rect x="3" y="14" width="7" height="7" rx="1"/><rect x="14" y="14" width="7" height="7" rx="1"/></svg></div>
235+
<h3>Slide templates <span class="badge-new">New</span></h3>
236+
<p>Fillable layouts — welcome screen, announcement, menu board, event schedule — so anyone can build a good-looking slide in minutes, no design skills required.</p>
237+
</div></div></div>
238+
226239
<div class="cell cell-4 rv"><div class="shell"><div class="core">
227240
<div class="f-icon amber"><svg width="19" height="19" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><rect x="2" y="3" width="20" height="14" rx="2"/><path d="M8 21h8m-4-4v4"/><circle cx="18.5" cy="5.5" r="2"/></svg></div>
228241
<h3>Standalone apps</h3>
@@ -361,6 +374,7 @@ <h4>Product</h4>
361374
<ul>
362375
<li><a href="download.html">Download</a></li>
363376
<li><a href="roadmap.html">Roadmap</a></li>
377+
<li><a href="api.html">REST API</a></li>
364378
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
365379
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
366380
</ul>

docs/roadmap.html

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,13 @@ <h1 class="grad-text rv" data-d="1">Where DisplayGrid is going</h1>
7171
<div class="lane-head rv">
7272
<span class="dot"></span>
7373
<h2>Shipped</h2>
74-
<span class="count">9 releases</span>
74+
<span class="count">10 releases</span>
7575
</div>
7676
<div class="rm-list">
77+
<div class="rm-row rv">
78+
<div class="rm-row-head"><h3>REST API, emergency presets &amp; slide templates</h3><span class="rm-tag ship">v1.0.28 · Jul 2026</span></div>
79+
<p>A token-authenticated REST API for automation (Home Assistant, n8n, cron) covering the emergency override and read-only screen/playlist status — <a href="api.html" style="color:#93b4ff;">see the reference</a>. One-tap emergency presets (fire, lockdown, closure, and more) on the Overview page. Four fillable slide templates — welcome screen, announcement, menu board, event schedule — with live preview.</p>
80+
</div>
7781
<div class="rm-row rv">
7882
<div class="rm-row-head"><h3>Date-range scheduling</h3><span class="rm-tag ship">v1.0.27 · Jul 2026</span></div>
7983
<p>Give any slide a start and end date — “show the Christmas menu 1–24 December” — on top of the existing day-of-week and time-of-day windows. Runs indefinitely when left blank.</p>
@@ -121,10 +125,6 @@ <h2>In production</h2>
121125
<div class="rm-row-head"><h3>Remote display operations</h3><span class="rm-tag">operations</span></div>
122126
<p>See what each screen is actually showing right now from the dashboard, and reload or restart it remotely — no walk across the building when something looks wrong.</p>
123127
</div>
124-
<div class="rm-row rv">
125-
<div class="rm-row-head"><h3>Documented REST API</h3><span class="rm-tag">integrations</span></div>
126-
<p>A stable, documented API with automation tokens — trigger the emergency override from a script, bulk-upload assets, or wire DisplayGrid into n8n and Home Assistant.</p>
127-
</div>
128128
<div class="rm-row rv">
129129
<div class="rm-row-head"><h3>Ops &amp; troubleshooting guide</h3><span class="rm-tag">docs</span></div>
130130
<p>A proper “when things go wrong” page: where the logs live, how updates apply, and fixes for the most common setup issues.</p>
@@ -140,18 +140,10 @@ <h2>Planned</h2>
140140
<span class="count">Under consideration</span>
141141
</div>
142142
<div class="rm-list">
143-
<div class="rm-row rv">
144-
<div class="rm-row-head"><h3>Slide template library</h3><span class="rm-tag">content</span></div>
145-
<p>Pre-made, good-looking layouts — menu board, event schedule, welcome screen, announcement — so a volunteer can produce professional content in minutes without a designer.</p>
146-
</div>
147143
<div class="rm-row rv">
148144
<div class="rm-row-head"><h3>Native widgets</h3><span class="rm-tag">content</span></div>
149145
<p>Weather, news/RSS, calendar and service times, and countdowns as first-class slide types — the signage staples, beyond the existing clock.</p>
150146
</div>
151-
<div class="rm-row rv">
152-
<div class="rm-row-head"><h3>Emergency override templates</h3><span class="rm-tag">safety</span></div>
153-
<p>Pre-set fire, lockdown, and closure messages — one tap to broadcast the right full-screen alert to every display.</p>
154-
</div>
155147
<div class="rm-row rv">
156148
<div class="rm-row-head"><h3>Backup &amp; restore</h3><span class="rm-tag">reliability</span></div>
157149
<p>One-click export of the database and asset library to a single archive, and a matching import — for migrations, upgrades, and peace of mind.</p>
@@ -222,6 +214,7 @@ <h4>Product</h4>
222214
<ul>
223215
<li><a href="download.html">Download</a></li>
224216
<li><a href="roadmap.html">Roadmap</a></li>
217+
<li><a href="api.html">REST API</a></li>
225218
<li><a href="https://github.com/JoeMighty/DisplayGrid/releases" target="_blank" rel="noopener">Releases</a></li>
226219
<li><a href="https://github.com/JoeMighty/DisplayGrid" target="_blank" rel="noopener">GitHub</a></li>
227220
</ul>

0 commit comments

Comments
 (0)