Skip to content

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

Merged
abhiksark merged 2 commits into
mainfrom
dev
Jun 20, 2026
Merged

docs: refresh demo GIF for zero-config first run#30
abhiksark merged 2 commits into
mainfrom
dev

Conversation

@abhiksark

@abhiksark abhiksark commented Jun 20, 2026

Copy link
Copy Markdown
Owner

Promotes the refreshed demo GIF to main so the README shows the zero-config flow. Docs/asset only — no code or version change.

Summary by CodeRabbit

  • Documentation
    • Updated demo documentation and script to showcase a zero-configuration first-run experience, demonstrating the workflow from initial launch through exercise selection, code editing, hints, and CLI commands in a streamlined sequence.

The demo opened with the old 'pythonlings init --path … && cd …' flow, which 0.4.0 made unnecessary. Rewrite docs/demo.tape to lead with bare 'pythonlings' (auto-creates ~/.pythonlings and opens the first exercise), keep the F5-docs / F4-topics / quit choreography, and move list/hint after the TUI (they can't run before a workspace exists under zero-config). Regenerated the GIF and updated DEMO_GIF.md to match.
docs: refresh demo GIF for zero-config first run
@abhiksark abhiksark merged commit fe55d9c into main Jun 20, 2026
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b575994f-7c49-4add-b559-e103c2652151

📥 Commits

Reviewing files that changed from the base of the PR and between 047694c and 3c9e5c4.

⛔ Files ignored due to path filters (1)
  • docs/assets/demos/pythonlings-demo.gif is excluded by !**/*.gif
📒 Files selected for processing (2)
  • docs/DEMO_GIF.md
  • docs/demo.tape

📝 Walkthrough

Walkthrough

The demo tape (docs/demo.tape) is updated to use a throwaway HOME under /tmp/pythonlings-demo and launch pythonlings directly without an explicit init step. docs/DEMO_GIF.md is updated to match, rewriting the numbered workflow to start with the zero-setup first run.

Changes

Demo zero-setup first-run flow

Layer / File(s) Summary
Tape: disposable HOME, launch, and TUI navigation
docs/demo.tape
Adds a hidden pre-step creating /tmp/pythonlings-demo as a throwaway HOME, removes the prior explicit init/cd flow, launches pythonlings directly to open the first exercise, and adjusts keystroke ordering and Sleep timings for TUI navigation and the CLI segment.
DEMO_GIF.md: updated workflow steps
docs/DEMO_GIF.md
Rewrites the "What the Demo Shows" numbered list to begin with running pythonlings with no prior setup, matching the updated tape sequence.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related issues

Poem

🐇 Hop into the demo, no setup required,
A fresh /tmp home is all that's desired.
pythonlings runs from a clean little den,
No init, no fuss — just code once again!
The tape and the docs now dance in one line,
First-run flows freely, like rain and sunshine. ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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