docs: add visual walkthrough to README with screenshots (#11) · StewAlexander-com/python-tutor@a60aae5 · GitHub
Skip to content

Commit a60aae5

Browse files
StewAlexander-comKarim13014claude
authored
docs: add visual walkthrough to README with screenshots (#11)
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 Code <claude-code@anthropic.com> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent ffd931e commit a60aae5

9 files changed

Lines changed: 330 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 57 additions & 0 deletions
409 KB
Loading
351 KB
Loading
454 KB
Loading
314 KB
Loading
402 KB
Loading
476 KB
Loading

‎docs/assets/screenshots/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Walkthrough screenshots
2+
3+
These images are linked from the project [README](../../../README.md) to give
4+
visitors a quick visual tour of the Python Tutor.
5+
6+
| File | What it shows |
7+
| ---------------------------- | -------------------------------------------------------------- |
8+
| `01-home.png` | Landing page — two learning paths and the "Ask tutor" FAB. |
9+
| `02-lesson-browser.png` | The 46-section beginner browser with search. |
10+
| `03-section-view.png` | A lesson opened in the **Teaching** reading mode. |
11+
| `04-code-lab-run.png` | The inline code lab after pressing **Run** (stdout panel). |
12+
| `05-evaluate-feedback.png` | Tutor evaluation: assessment, feedback, next step, references. |
13+
| `06-tutor-chat.png` | Floating chat panel mid-conversation. |
14+
15+
## How they're generated
16+
17+
The shots are captured by [`scripts/capture-screenshots.js`](../../../scripts/capture-screenshots.js)
18+
using Playwright. The script serves `frontend/` on a local port and **mocks**
19+
`/api/health`, `/api/run`, `/api/evaluate`, and `/api/chat` so the UI renders
20+
its happy-path states without requiring Ollama to be installed or running.
21+
22+
The mocked model responses are **deterministic fixtures** chosen to illustrate
23+
the UI — they are *not* real Gemma output. If you want screenshots of real
24+
model output, start the backend (`./run.sh`) and capture them manually.
25+
26+
To regenerate:
27+
28+
```bash
29+
npm i --no-save playwright
30+
npx playwright install chromium
31+
node scripts/capture-screenshots.js
32+
```

‎scripts/capture-screenshots.js‎

Lines changed: 241 additions & 0 deletions

0 commit comments

Comments
 (0)