Skip to content

docs(readme): add real UI screenshots to the visual intro (#156)#224

Merged
takashikasuya merged 1 commit into
mainfrom
claude/readme-screenshots
Jul 18, 2026
Merged

docs(readme): add real UI screenshots to the visual intro (#156)#224
takashikasuya merged 1 commit into
mainfrom
claude/readme-screenshots

Conversation

@takashikasuya

Copy link
Copy Markdown
Contributor

Summary

Closes the remaining part of #156 — the persona restructure already landed (#171), and the only open item was "README has zero images." This replaces the スクリーンショット準備中 / 実 UI を起動できないため未添付(メンテナ対応) placeholder in the 見た目と最初の1コマンド section with three real captures of the running app, the exact 3 the issue recommends:

Screen What it shows
operator-home.png Operator home — freshness summary (最新/鮮度切れ/欠測) + 要対応ポイント list
resource-explorer.png Resource explorer — building→floor→… equipment tree + detail pane
point-detail.png Point detail — latest value + freshness badge + telemetry history chart

How they were captured (offline, reproducible)

The placeholder claimed the automation environment can't run the UI — it can, via the repo's existing route-mocked Playwright harness. A new committed spec, web-client/e2e/capture-readme-screenshots.spec.ts, drives the real Next.js app against page.route() mocks (sample-twin-equivalent data, no backend/Docker) using the preinstalled chromium, and writes the PNGs to docs/screenshots/. So the images regenerate on UI changes:

npx playwright test e2e/capture-readme-screenshots.spec.ts

The README caption is honest that these are route-mocked renders (not a live-stack capture) and points readers at make demo for live data.

Test plan

  • npx playwright test e2e/capture-readme-screenshots.spec.ts — 3/3 pass, PNGs verified by eye (clean values, no dev-overlay badge)
  • yarn typecheck — clean · yarn lint — 0 errors
  • Docs + new e2e spec + images only; no runtime source touched (the Playwright job is workflow_dispatch-only per repo convention, so it won't run this spec in CI)

Checklist

  • I read CONTRIBUTING.md and followed the coding conventions in CLAUDE.md
  • I added or updated tests for the change — n/a (docs; the capture spec is the regeneration tool)
  • I updated relevant docs (README.md)

Note: screenshots are brand-facing — if you'd prefer different framing, crops, or live-stack captures, say so and I'll regenerate (the spec makes that a one-liner).

🤖 Generated with Claude Code


Generated by Claude Code

Replaces the "スクリーンショット準備中 / 実 UI を起動できないため未添付" placeholder
in the 見た目と最初の1コマンド section with three real captures of the running app:
operator home (freshness summary + attention list), resource explorer (equipment
tree + detail), and point detail (latest value + freshness badge + history chart).

The persona restructure part of #156 already landed (#171); this closes the
remaining "no images" gap. The screenshots are captured from the real Next.js app
driven against the route-mocked e2e API (no backend/Docker needed) via a new
committed Playwright spec (e2e/capture-readme-screenshots.spec.ts) so they can be
regenerated on UI changes — the README notes they use sample-twin-equivalent data
and points readers at `make demo` for live data.

Captured with the preinstalled chromium; the caption is honest that these are
route-mocked renders, not a live-stack capture.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XEG6csNA9GDkQzT37CwAUp
Signed-off-by: Claude <noreply@anthropic.com>
@takashikasuya
takashikasuya merged commit d679b06 into main Jul 18, 2026
6 checks passed
@takashikasuya
takashikasuya deleted the claude/readme-screenshots branch July 18, 2026 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants