Wiki: user guide for the panel, plus quick install #311

Closed
opened 2026-11-17 17:09:51 +00:00 by vivy · 1 comment
Owner

Product owner's request (GRI-2192, 2026-11-17): a user guide in the repo wiki, for people who are not technical, or who want to see how the interface works before they try it. Today it is "figure it out yourself".

Scope:

  • How to use the panel: log in, upload media (images, PDF, video), build a playlist / schedule, assign it to a device, check what a screen shows.
  • Screenshots of each step.
  • A quick install page only. The full manual install stays in README.md.
  • No developer or API docs in the wiki.

Done when: the wiki has a home page with a table of contents and the pages above, and it matches the panel in dev.

Product owner's request (GRI-2192, 2026-11-17): a user guide in the repo **wiki**, for people who are not technical, or who want to see how the interface works before they try it. Today it is "figure it out yourself". Scope: - How to use the panel: log in, upload media (images, PDF, video), build a playlist / schedule, assign it to a device, check what a screen shows. - Screenshots of each step. - A **quick install** page only. The full manual install stays in `README.md`. - No developer or API docs in the wiki. Done when: the wiki has a home page with a table of contents and the pages above, and it matches the panel in `dev`.
Author
Owner

The user guide is in the wiki: https://git.grimoirix.org/Grimoirix/grimoire-of-digital-signage/wiki/Home

Pages (all linked from Home and from the sidebar on every page):

Page Covers
Home what Scryglass is, table of contents, the words the guide uses
Quick install the one-line server and device installs, upgrade/remove; links to the README for everything else
First start the two setup questions and the admin account
Log in log in, and what each top button is for
Upload media image, video, PDF, PowerPoint, web page; the media library
Build a playlist new playlist, add items, PDF page ranges, durations, order, save, playlist settings
Add a screen approve a pending device, make a campus, name the device
Assign a playlist tick the screens, refresh, unassign
Check what a screen shows the device status labels, a capture of the real screen, what to check when it is wrong

How it was made to match dev. 21 screenshots, all from dev at aeab4f8: the real server and panel against a scratch Postgres, driven by a headless browser, and a real grimoirix-signage-client (GTK build) on a virtual display. So the screen capture on the last page is what the client actually played: image, PDF page, video. No mock-up.

Two things the guide says plainly, because they are true in dev today:

  • Time-based schedules are not in the panel. The issue asked for "playlist / schedule"; the guide says a screen plays its one playlist all day.
  • The device status label (Updating / Up to date / Offline) only appears after a change while the Devices page is open (the panel's own comment points at #248). The guide tells the reader what to do when no label shows.

Out of scope, left alone: no developer or API pages. Users, IP rules, network and language settings are not described beyond one line each.

The scripts that made the screenshots are in /workspace/tasks/GRI-2196/screenshot-scripts so the pictures can be redone when the panel changes.

The user guide is in the wiki: https://git.grimoirix.org/Grimoirix/grimoire-of-digital-signage/wiki/Home **Pages** (all linked from Home and from the sidebar on every page): | Page | Covers | | --- | --- | | Home | what Scryglass is, table of contents, the words the guide uses | | Quick install | the one-line server and device installs, upgrade/remove; links to the README for everything else | | First start | the two setup questions and the admin account | | Log in | log in, and what each top button is for | | Upload media | image, video, PDF, PowerPoint, web page; the media library | | Build a playlist | new playlist, add items, PDF page ranges, durations, order, save, playlist settings | | Add a screen | approve a pending device, make a campus, name the device | | Assign a playlist | tick the screens, refresh, unassign | | Check what a screen shows | the device status labels, a capture of the real screen, what to check when it is wrong | **How it was made to match `dev`.** 21 screenshots, all from `dev` at `aeab4f8`: the real server and panel against a scratch Postgres, driven by a headless browser, and a real `grimoirix-signage-client` (GTK build) on a virtual display. So the screen capture on the last page is what the client actually played: image, PDF page, video. No mock-up. **Two things the guide says plainly, because they are true in `dev` today:** - Time-based schedules are not in the panel. The issue asked for "playlist / schedule"; the guide says a screen plays its one playlist all day. - The device status label (Updating / Up to date / Offline) only appears after a change while the Devices page is open (the panel's own comment points at #248). The guide tells the reader what to do when no label shows. **Out of scope, left alone:** no developer or API pages. Users, IP rules, network and language settings are not described beyond one line each. The scripts that made the screenshots are in `/workspace/tasks/GRI-2196/screenshot-scripts` so the pictures can be redone when the panel changes.
vivy closed this issue 2026-11-17 17:35:59 +00:00
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
Grimoirix/grimoire-of-digital-signage#311
No description provided.