Skip to content

docs: refresh media assets, embed setup screenshot, promote downloads badge - #242

Merged
elkaix merged 3 commits into
mainfrom
docs/refresh-media-and-badges
Jul 23, 2026
Merged

docs: refresh media assets, embed setup screenshot, promote downloads badge#242
elkaix merged 3 commits into
mainfrom
docs/refresh-media-and-badges

Conversation

@elkaix

@elkaixelkaix commented Jul 23, 2026

Copy link
Copy Markdown
Member

Summary

  • Regenerate docs/media/shell-mode.gif from a new recording (ffmpeg palette pipeline, 860px/10fps, 3.1 MB) and refresh docs/media/setup.png
  • Embed the setup screenshot (login provider picker) in the README Authenticate section
  • Promote the PyPI downloads badge to the primary badge row using the shields.io pepy endpoint (for-the-badge style)

Docs/media only — no shipped code paths touched, so no changelog entry is required.

[skip changelog]

Summary by CodeRabbit

  • Documentation
    • Updated the project’s download statistics badge and destination link.
    • Added a visual example of the login provider selection screen to the authentication instructions.

@coderabbitai

coderabbitaiBot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 134a04c3-49d0-4196-a187-547b2363b3c3

📥 Commits

Reviewing files that changed from the base of the PR and between 9700655 and 6391725.

⛔ Files ignored due to path filters (2)
  • docs/media/setup.png is excluded by !**/*.png, !docs/**
  • docs/media/shell-mode.gif is excluded by !**/*.gif, !docs/**
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README badges were updated, and the optional authentication section now includes a centered image showing the login provider picker.

Changes

README updates

Layer / File(s)Summary
Downloads badge update
README.md
The PyPI downloads badge and link were replaced with a Pepy/shields downloads badge while preserving the surrounding badges.
Authentication setup visual
README.md
A centered setup.png image was added after the pythinker login example.

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

Suggested labels:documentation

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check nameStatusExplanationResolution
Description check⚠️ WarningThe description omits the required Related Issue section and checklist, and it doesn't follow the repository template.Add the Related Issue block with Resolve #(issue_number), keep the Description section, and include the checklist items from the template.
✅ Passed checks (4 passed)
Check nameStatusExplanation
Title check✅ PassedThe title uses a valid conventional-commit prefix and accurately summarizes the documentation/media updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 docs/refresh-media-and-badges

Warning

Billing warning: we have not been able to collect payment for this subscription for more than 72 hours. Please update the payment method or pay any pending invoices in Billing to avoid service interruption.


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

@codecov

codecovBot commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@elkaix
elkaix merged commit 5493e57 into mainJul 23, 2026
35 checks passed
@elkaix
elkaix deleted the docs/refresh-media-and-badges branch July 23, 2026 17:16
Sign up for freeto 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

@elkaix