From edb9bddab19253e8588e6fd54f72d628d045f64e Mon Sep 17 00:00:00 2001 From: librelad Date: Fri, 29 May 2026 01:37:36 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20add=20CLAUDE.md=20=E2=80=94=20verify=20?= =?UTF-8?q?WebUI=20changes=20visually=20with=20lp-shot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Directive for agents working on the repo: after a user-visible WebUI change, screenshot the route with the lp-shot helper and review the PNG before marking done, rather than relying on syntax checks alone. Box-specific setup (port discovery, auth, install) is kept out of the repo. Co-Authored-By: Claude Opus 4.7 Signed-off-by: librelad --- CLAUDE.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..635002b --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,19 @@ +# LibrePortal — agent notes + +## Verify WebUI changes visually before marking them done +After changing anything user-visible in the WebUI (`containers/libreportal/frontend/`), +confirm it actually renders correctly — syntax checks and type-correctness don't +catch layout or visual regressions. + +The maintainer's dev environment provides a headless screenshot helper, `lp-shot`, +that captures a WebUI route (or a single element, via a trailing CSS selector) to a +PNG for review: + +``` +lp-shot /admin/system # full route -> /tmp/webui-shot.png +lp-shot /admin/system /tmp/x.png 12 ".sys-strip" # just one element, crisp +``` + +Use it (and read the PNG) to self-check UI work instead of assuming it looks right or +asking the user to look. Skip it for purely backend/non-visual edits. If `lp-shot` +isn't present, fall back to asking the user for a screenshot.