Skip to content

docs: add a screenshot banner to the README - #143

Merged
NeoVand merged 1 commit into
mainfrom
docs/readme-banner
Aug 13, 2026
Merged

docs: add a screenshot banner to the README#143
NeoVand merged 1 commit into
mainfrom
docs/readme-banner

Conversation

@NeoVand

@NeoVand NeoVand commented Aug 13, 2026

Copy link
Copy Markdown
Owner

What changed

The README opened with the logo and a one-line pitch, so nothing showed what Voicebook actually looks like until you clicked through to the live app. This adds the onboarding screen — "Choose how Voicebook reads", with the on-device / bring-your-own-key split for both the reading voice and visual descriptions — as a banner directly under the badges, linked to the live app.

The image was dropped in the repo root as screenshot.png; it now lives at docs/images/voicebook-onboarding.png, a new folder alongside the other docs, so it travels with the documentation instead of the deployed static/ bundle. Alt text describes the choice the screen presents rather than naming the file.

Docs only — no source, storage, or network behavior touched.

Verification

  • npm run lint (prettier + eslint clean)
  • npm run check — not run; no TypeScript or Svelte files changed
  • npm run test:coverage — not run; no application code changed
  • Relevant Chromium/visual journey — not applicable

Review checklist

  • Privacy and network behavior are unchanged or explicitly explained. — unchanged; the banner is a repo-relative image, no third-party embed.
  • Storage/migration and model-license implications are covered. — none.
  • Keyboard, screen-reader, contrast, and reduced-motion behavior are covered. — the image carries descriptive alt text; nothing in the app changed.
  • Visual changes include desktop screenshots. — the change is a desktop screenshot; render it on the PR's Files tab to check it.

🤖 Generated with Claude Code

The README opened with the logo and a one-line pitch, so nothing showed
what Voicebook actually looks like before someone clicked through to the
live app. Add the onboarding screen — the choice between on-device and
bring-your-own-key engines — as a banner under the badges, linked to the
live app, with alt text describing what the screen offers.

The image lives in a new docs/images/ folder rather than static/, so it
ships with the docs instead of the deployed app bundle.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@NeoVand
NeoVand merged commit 3be3cf5 into main Aug 13, 2026
5 checks passed
@NeoVand
NeoVand deleted the docs/readme-banner branch August 13, 2026 06:24
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