Skip to content

docs: introduce playful Pythonlings visual identity - #60

Merged
abhiksark merged 3 commits into
mainfrom
agent/playful-pythonlings-brand
Aug 15, 2026
Merged

docs: introduce playful Pythonlings visual identity#60
abhiksark merged 3 commits into
mainfrom
agent/playful-pythonlings-brand

Conversation

@abhiksark

@abhiksark abhiksark commented Aug 15, 2026

Copy link
Copy Markdown
Owner

Summary

Public project surfaces now present a consistent Pythonlings identity and current pythonlings product captures.

  • Uses the approved mascot artwork without redrawing its face, proportions, colors, or prompt details.
  • Adds transparent PNG mascot, color lockup, monochrome lockup, and a 1280 x 640 README hero using the selected horizontal layout.
  • Centers the hero and existing badges while keeping the quick-start flow near the top of the README.
  • Uses the evergreen tagline: "Learn Python by fixing tiny broken programs."
  • Replaces the documentation logo with the full mascot and uses an exact head crop for a readable small favicon.
  • Refreshes the coding, local reference, topic picker, and demo captures from real application states.
  • Leaves Python APIs, CLI behavior, package metadata, curriculum, and learner state unchanged.

Tests

  • python -m pytest -q: 151 passed in 21.01s.
  • pythonlings --root tests/fixtures/passing_curriculum verify: passing1 and passing2 passed.
  • mkdocs build --strict: passed in 0.16s. Material for MkDocs printed its upstream MkDocs 2.0 advisory.
  • git diff --check: passed.
  • PNG asset audit: all six branding files decode successfully and have the expected dimensions, color modes, and transparency behavior.
  • README and MkDocs audit: meaningful hero alt text, hero-badge-quick-start hierarchy, and generated documentation asset wiring passed.
  • Demo GIF audit: 1200 x 760, 343 frames, and 13.720 seconds.
  • Rendered and inspected the favicon at 16, 32, and 64 pixels, plus the lockups and hero on light and dark backgrounds.
  • Inspected all three 1400 x 906 application captures and the complete GIF for current naming and real product behavior.

Screenshots

Pythonlings README hero

Pythonlings terminal demo

Checklist

  • Updated documentation for the approved visual identity
  • Added or updated tests (not applicable: public assets only)
  • Verified python -m pytest -q

Summary by CodeRabbit

  • Documentation
    • Redesigned the README introduction with a centered hero image, project badges, documentation link, and concise tagline.
    • Updated the demo walkthrough to dismiss the onboarding prompt after launching the application.
    • Updated the documentation site branding to use PNG logo and favicon assets.

@coderabbitai

coderabbitai Bot commented Aug 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a3326ea2-c38b-402b-b1b6-ef851b5adaee

📥 Commits

Reviewing files that changed from the base of the PR and between 0a5969b and fe42fd4.

⛔ Files ignored due to path filters (12)
  • docs-site/assets/favicon.png is excluded by !**/*.png
  • docs-site/assets/favicon.svg is excluded by !**/*.svg
  • docs-site/assets/logo.png is excluded by !**/*.png
  • docs-site/assets/logo.svg is excluded by !**/*.svg
  • docs/assets/branding/pythonlings-hero.png is excluded by !**/*.png
  • docs/assets/branding/pythonlings-logo-monochrome.png is excluded by !**/*.png
  • docs/assets/branding/pythonlings-logo.png is excluded by !**/*.png
  • docs/assets/branding/pythonlings-mascot.png is excluded by !**/*.png
  • docs/assets/demos/pythonlings-demo.gif is excluded by !**/*.gif
  • docs/assets/screenshots/coding-screen.png is excluded by !**/*.png
  • docs/assets/screenshots/docs-reference.png is excluded by !**/*.png
  • docs/assets/screenshots/topic-picker.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • Readme.md
  • docs/demo.tape
  • mkdocs.yml
📜 Recent review details
🔇 Additional comments (4)
Readme.md (2)

1-1: LGTM!

Also applies to: 4-16


2-3: 🗄️ Data Integrity & Integration

Documentation asset references are valid. All referenced assets exist with exact case and are tracked.

mkdocs.yml (1)

1-1: LGTM!

docs/demo.tape (1)

1-1: LGTM!

Also applies to: 26-29


📝 Walkthrough

Walkthrough

The changes refresh README branding, update MkDocs logo and favicon references, and modify the demo tape to dismiss first-run onboarding before the coding screen appears.

Changes

Documentation presentation

Layer / File(s) Summary
README and documentation branding
Readme.md, mkdocs.yml
The README now uses centered branding, linked badges, a documentation link, and a Python-learning tagline. MkDocs now references PNG logo and favicon assets.
Demo onboarding flow
docs/demo.tape
The demo tape identifies its file and dismisses first-run onboarding after launching pythonlings, then waits for the coding screen.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to fe42f

This documentation-only change updates branding and product captures without changing Python APIs, CLI behavior, package metadata, curriculum, or learner state; no actionable merge-blocking risk remains after normal checks and review.

Poem

A rabbit refreshed the README bright,
With badges and logos aligned just right.
The demo now skips onboarding’s gate,
And waits for the lesson to settle in place.
Hop, hop—documentation looks great!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation and branding changes across the Pythonlings project.
Description check ✅ Passed The description includes all required sections and provides detailed changes, tests, screenshots, and checklist results.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/playful-pythonlings-brand

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.

@abhiksark abhiksark self-assigned this Aug 15, 2026
@abhiksark abhiksark added documentation Improvements or additions to documentation enhancement New feature or request size: M Medium, self-contained contribution labels Aug 15, 2026 — with ChatGPT Codex Connector
@abhiksark
abhiksark marked this pull request as ready for review August 15, 2026 18:42
@abhiksark
abhiksark merged commit 4e3af85 into main Aug 15, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request size: M Medium, self-contained contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant