docs: film teaser GIF at the top of the README - #12
Conversation
20-second cut of the explainer film (WITH COVENANT card, quarantine button, 423 Locked in the terminal, end card), 640px at 8fps, 8.6MB. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughAn animated GIF banner was added to README.md beneath the existing status and license badges near the top of the document. No other content, structure, or exported entities were modified. ChangesREADME Update
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Tools execution failed with the following error: Failed to run tools: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error) 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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
9-9: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick winPin the banner asset to a release tag.
Hotlinking
mainmakes published README renders a moving target; future commits can change or remove the image without a new release. A versioned URL would keep the PyPI/GitHub preview stable.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 9, The README banner image is hotlinked to the moving main branch, which makes published renders unstable. Update the banner URL in the README to point at a specific release-tagged asset instead of main so the image stays fixed for each release; locate it by the markdown banner image reference near the top of the README.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Line 9: The README banner image is hotlinked to the moving main branch, which
makes published renders unstable. Update the banner URL in the README to point
at a specific release-tagged asset instead of main so the image stays fixed for
each release; locate it by the markdown banner image reference near the top of
the README.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 62bfa07e-e48c-40d3-95d1-a5b3e1a9b3af
⛔ Files ignored due to path filters (1)
docs/assets/covenant-film.gifis excluded by!**/*.gif
📒 Files selected for processing (1)
README.md
Embeds a 20-second teaser cut of the finished explainer film above the fold: the WITH COVENANT card types on, the doctor slams the quarantine button, the agent gets a clean
423 Locked — quarantined by Covenantinstead of silently wrong data, and the end card lands onpip install covenant-mcp— which is exactly what the quickstart below it says.docs/assets/covenant-film.gif: 640px, 8fps, 151 frames, 8.6MB (end card holds 1.8s before the loop)main— it renders the moment this merges, same as the existing assets did🤖 Generated with Claude Code
Summary by CodeRabbit