Skip to content

fix: use clickable thumbnail for demo video in README#72

Merged
rohitg00 merged 1 commit intomainfrom
fix/readme-video-display
Mar 4, 2026
Merged

fix: use clickable thumbnail for demo video in README#72
rohitg00 merged 1 commit intomainfrom
fix/readme-video-display

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented Mar 4, 2026

Summary

  • GitHub doesn't render <video> tags in README markdown
  • Replace with clickable thumbnail image (assets/demo-thumbnail.png) that links to the raw mp4
  • Clicking the thumbnail downloads/plays the demo video

Test plan

  • Thumbnail renders on GitHub
  • Click opens the mp4 file

Summary by CodeRabbit

  • Documentation
    • Updated README presentation: replaced embedded video with a linked thumbnail image and caption.

GitHub doesn't render <video> tags in markdown. Replace with a
clickable thumbnail image that links to the raw mp4 file.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7cd4fdfc-5851-4986-bef4-98150ecb6b92

📥 Commits

Reviewing files that changed from the base of the PR and between b9d7ea9 and 843d1ee.

⛔ Files ignored due to path filters (1)
  • assets/demo-thumbnail.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README was updated to replace a video element with a linked thumbnail image and caption for demonstrating the project. This is purely a documentation presentation change with no modifications to functional code or logic.

Changes

Cohort / File(s) Summary
Documentation
README.md
Replaced video element embedding with linked thumbnail image and caption for demo media presentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 A carrot-bright thumbnail appears,
Where video once played with cheers,
A linked image, neat and small,
Guides readers through it all!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix: use clickable thumbnail for demo video in README' directly and accurately describes the main change—replacing the video element with a clickable thumbnail image for the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/readme-video-display

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.

@rohitg00 rohitg00 merged commit 3b3db8d into main Mar 4, 2026
1 check passed
@rohitg00 rohitg00 deleted the fix/readme-video-display branch March 4, 2026 11:20
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