Skip to content

docs: refresh demo GIF for zero-config first run #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abhiksark merged 2 commits into from
Jun 20, 2026
Merged

docs: refresh demo GIF for zero-config first run #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
105e6fa
docs: refresh demo GIF for zero-config first run
abhiksark Jun 20, 2026
3c9e5c4
Merge pull request #29 from abhiksark/feature/refresh-demo-gif
abhiksark Jun 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/DEMO_GIF.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ loads quickly on GitHub and PyPI.

The scripted flow should stay focused on the first-time user path:

1. Initialize a clean workspace.
2. Show topic progress with `pythonlings list`.
3. Show a hint and official docs link with `pythonlings hint variables1`.
4. Open the Pythonlings TUI.
5. Show the first pending exercise in the coding screen.
6. Open and close the local docs window with `F5` and `Esc`.
7. Open the topic picker with `F4`.
8. Quit with `Ctrl+Q`.
1. Run `pythonlings` with no setup — it creates `~/.pythonlings` and opens the
first pending exercise (zero-config first run).
2. Show the first pending exercise in the coding screen.
3. Open and close the local docs window with `F5` and `Esc`.
4. Open the topic picker with `F4`.
5. Quit with `Ctrl+Q`.
6. Show topic progress with `pythonlings list`.
7. Show a hint and official docs link with `pythonlings hint variables1`.

## Fallback Workflow

Expand Down
Binary file modified docs/assets/demos/pythonlings-demo.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 22 additions & 17 deletions docs/demo.tape
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,41 @@ Set Padding 16
Set Framerate 16
Set TypingSpeed 35ms

Type "pythonlings init --path /tmp/pythonlings-demo"
# Hidden setup: a throwaway HOME so `pythonlings` creates a fresh ~/.pythonlings
# without touching the real one, from a non-workspace directory so zero-config
# resolution kicks in. None of this is recorded.
Hide
Type 'export HOME=/tmp/pythonlings-demo && rm -rf "$HOME" && mkdir -p "$HOME" && cd "$HOME" && clear'
Enter
Sleep 1s

Type "cd /tmp/pythonlings-demo"
Enter
Sleep 300ms

Type "pythonlings list"
Enter
Sleep 1.5s

Type "pythonlings hint variables1"
Enter
Sleep 1.5s
Sleep 500ms
Show

# Zero-config: one command creates the workspace and opens the first exercise.
Type "pythonlings"
Enter
Sleep 2s
Sleep 3s

# Coding screen -> local Python reference (F5), then close it (Esc)
Escape
Type@0ms "[15~"
Sleep 2s

Escape
Sleep 700ms

# Topic picker (F4)
Escape
Type@0ms "OS"
Sleep 1.5s

# Quit back to the shell
Ctrl+Q
Sleep 500ms
Sleep 800ms

# There's a CLI too: progress and hints
Type "pythonlings list"
Enter
Sleep 1.5s

Type "pythonlings hint variables1"
Enter
Sleep 1.8s
Loading