docs: add a screenshot banner to the README - #143
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 atdocs/images/voicebook-onboarding.png, a new folder alongside the other docs, so it travels with the documentation instead of the deployedstatic/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 changednpm run test:coverage— not run; no application code changedReview checklist
🤖 Generated with Claude Code