docs: add visual walkthrough to README with screenshots#11
Merged
Conversation
Add a "A quick look" section to the README showing six screenshots of the UI: home, lesson browser, lesson view, code lab Run output, Evaluate feedback, and the floating tutor chat. Visuals over prose, short captions, 2x2 table layout. Screenshots are committed under docs/assets/screenshots/ and are generated by a new scripts/capture-screenshots.js Playwright script that serves the frontend and mocks /api/* with deterministic fixtures, so they can be regenerated without Ollama installed. A README in the screenshots folder documents the fixtures and the regenerate command. Co-Authored-By: Claude Opus 4.7 <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
2 participants
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.
Summary
docs/assets/screenshots/and add a smallREADME.mdthere explaining what each one shows and how the fixtures work.scripts/capture-screenshots.js— a Playwright script that servesfrontend/and mocks/api/health,/api/run,/api/evaluate, and/api/chatwith deterministic fixtures so the shots can be regenerated without Ollama running.The mocked model responses are explicitly called out as fixtures, not real Gemma output — the UI is faithful; only the words on screen are scripted.
Test plan
node --check scripts/capture-screenshots.jsnode scripts/capture-screenshots.jsend-to-end; all six PNGs render and were eyeballedREADME.mdresolve to files in the repobackend tests,Frontend JS syntax check, andShell script lint + smokejobs unaffected