Skip to content

Add README video previews#109

Merged
Moskize91 merged 1 commit into
mainfrom
codex/update-readme-media
Jul 9, 2026
Merged

Add README video previews#109
Moskize91 merged 1 commit into
mainfrom
codex/update-readme-media

Conversation

@Moskize91

Copy link
Copy Markdown
Contributor

Summary

  • add YouTube preview image/link to the English README
  • add Bilibili preview image/link to the Chinese README
  • include localized 16:9 preview assets under docs/images

Validation

  • git diff --check

@coderabbitai

coderabbitai Bot commented Jul 9, 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

Run ID: ad30cb20-c9e5-4395-abe2-9a17860b9ecb

📥 Commits

Reviewing files that changed from the base of the PR and between b0e1639 and eca710f.

⛔ Files ignored due to path filters (2)
  • docs/images/bilibili-cover.png is excluded by !**/*.png
  • docs/images/youtube-cover.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • README.md
  • README_zh-CN.md

Summary by CodeRabbit

  • Documentation
    • Added a “Watch the video” thumbnail link to the main README, placed near the start of the guide.
    • Added a matching video thumbnail link to the Chinese README for easier access to the introduction video.

Walkthrough

This change adds a video thumbnail link to both README.md and README_zh-CN.md, positioned before the Quick Start section. The English README includes a "Watch the video" link pointing to YouTube, while the Chinese README includes a corresponding Bilibili video cover link. No code or public API changes are involved.

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title matches the change, but it does not follow the required <type>(<scope>): <subject> format. Rewrite it as feat(readme): add video previews or a similar English title that matches the required format.
✅ Passed checks (3 passed)
Check name Status Explanation
Description check ✅ Passed The description matches the README video preview additions and mentions the updated assets and validation.
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
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch codex/update-readme-media

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

@Moskize91 Moskize91 merged commit 0352f95 into main Jul 9, 2026
3 checks passed
@Moskize91 Moskize91 deleted the codex/update-readme-media branch July 9, 2026 06:47
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