Skip to content

docs: screenshot-driven user guide + preview mockups#7

Merged
valehdba merged 1 commit into
mainfrom
claude/reverent-liskov-0b076b
May 9, 2026
Merged

docs: screenshot-driven user guide + preview mockups#7
valehdba merged 1 commit into
mainfrom
claude/reverent-liskov-0b076b

Conversation

@valehdba
Copy link
Copy Markdown
Owner

@valehdba valehdba commented May 9, 2026

Summary

Trailing commit on claude/reverent-liskov-0b076b that PR #5 didn't carry — pushed after the squash-merge. Adds an end-user walkthrough of every screen plus the infrastructure to regenerate the screenshots.

What's in this PR

  • docs/USER_GUIDE.md — annotated walkthrough of register, unlock, the searchable/groupable credential grid, the add-credential form, and both extension popup states. Each section explains what the user sees, what happens client-side under zero-knowledge, and how the controls behave.
  • docs/preview/ — eight standalone HTML mockups that <link rel=\"stylesheet\" href=\"../../packages/web/src/styles.css\">, so any change to the live CSS shows up in the screenshots without re-mocking. Includes a tiny server.mjs (Node http, scoped to the worktree root so the relative styles.css path resolves) and an index page listing all mockups.
  • docs/img/ — captured PNGs (Chrome headless, 1280×900 for web pages, 400×360 for the extension popup).
  • .claude/launch.json — wires the preview server into the in-IDE preview tool so contributors can run node docs/preview/server.mjs with one click.
  • README.md — single line, links the new guide alongside ARCHITECTURE.md and SECURITY.md.

Reproducibility

The guide includes the exact Chrome-headless one-liner used to regenerate the PNGs, so when CSS or markup changes the maintainer can refresh the images in seconds without a separate screenshotting tool.

Verification

No code paths are touched. The web build still runs clean (npm run build --workspace=@passman/web); the merged main is already verified end-to-end after #6 unblocked the test suite.

🤖 Generated with Claude Code

- docs/USER_GUIDE.md walks through every screen of the web vault and
  Chrome extension popup with annotated screenshots: register, unlock,
  the searchable/groupable credential grid, the add-credential form,
  and the locked + unlocked extension popups.
- docs/preview/ holds standalone HTML mockups that reuse the live
  packages/web/src/styles.css; they double as a regression check for
  styling changes and as the source for re-capturing the PNGs.
- docs/preview/server.mjs is a minimal Node static server scoped to the
  worktree root (so the relative styles.css path resolves) and is
  wired up via .claude/launch.json for the in-IDE preview tool.
- docs/img/ stores the captured PNGs, generated by Chrome headless;
  the guide documents the exact one-liner to regenerate them.
- README links the new guide alongside ARCHITECTURE and SECURITY.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@valehdba valehdba merged commit 14960e2 into main May 9, 2026
7 checks passed
@valehdba valehdba deleted the claude/reverent-liskov-0b076b branch May 9, 2026 12:15
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.

1 participant