Skip to content

[codex] Add README demo video - #42

Merged
droid-ash merged 2 commits into
mainfrom
codex/add-demo-video-readme
Apr 1, 2026
Merged

droid-ash merged 2 commits into
mainfrom
codex/add-demo-video-readme

Conversation

@droid-ash

@droid-ash droid-ash commented Apr 1, 2026 •

Copy link
Copy Markdown
Owner

What changed

This PR adds a linked demo video section to both project READMEs.

  • Added a Watch Demo section to the root README
  • Added the same Watch Demo section to the package README used for npm
  • Used a linked YouTube thumbnail so the demo works in both GitHub and npm README rendering

Why

This makes the main product demo visible near the top of the documentation without relying on iframe embeds that are not reliably supported in README renderers.

Validation

  • Verified the change is limited to README.md and packages/cli/README.md
  • Confirmed both files now include the same demo section and YouTube link

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added "Watch Demo" sections with demo video links to documentation files for easier access to product demonstrations.

@coderabbitai

coderabbitai Bot commented Apr 1, 2026 •

Copy link
Copy Markdown

Warning

Rate limit exceeded

@droid-ash has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 13 minutes and 36 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 13 minutes and 36 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9e8aadab-315e-43cc-af8f-b48db40e5b62

📥 Commits

Reviewing files that changed from the base of the PR and between e03cc17 and 64557bb.

📒 Files selected for processing (2)
  • README.md
  • packages/cli/README.md
📝 Walkthrough

Walkthrough

Two README files were updated to include new "Watch Demo" sections. Each section contains a YouTube thumbnail link and a direct URL to a demo video, positioned before the Quick Start section.

Changes

Cohort / File(s) Summary
Documentation Demo Sections
README.md, packages/cli/README.md
Added "Watch Demo" sections featuring YouTube thumbnail imagery and direct links to demo videos.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A demo link so bright and true,
YouTube's magic in my view,
Hop along and watch the show,
Documentation's gentle glow,
Progress made, both far and wide!

🚥 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 clearly and concisely summarizes the main change: adding demo video links to README files. It is specific, relevant, and accurately represents the primary modification across both README files.
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
  • Commit unit tests in branch codex/add-demo-video-readme

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.

@droid-ash
droid-ash marked this pull request as ready for review April 1, 2026 08:09
@droid-ash
droid-ash requested a review from arnoldlaishram April 1, 2026 08:15
@droid-ash droid-ash self-assigned this Apr 1, 2026
@droid-ash
droid-ash merged commit 0d9a22f into main Apr 1, 2026
1 check passed
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