Skip to content

docs: film teaser GIF at the top of the README - #12

Merged
Mhemd139 merged 1 commit into
mainfrom
docs/film-embed
Jul 25, 2026
Merged

docs: film teaser GIF at the top of the README#12
Mhemd139 merged 1 commit into
mainfrom
docs/film-embed

Conversation

@Mhemd139

@Mhemd139 Mhemd139 commented Jul 8, 2026

Copy link
Copy Markdown
Owner

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 Covenant instead of silently wrong data, and the end card lands on pip 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)
  • Absolute raw URL like the other README assets, so it will render on PyPI at the next release too
  • Note: the image 404s in this PR's preview because the raw URL points at main — it renders the moment this merges, same as the existing assets did

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added an animated banner near the top of the README to give the project page a more engaging introduction.

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>
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

An 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.

Changes

README Update

Layer / File(s) Summary
Add GIF banner
README.md
An animated GIF illustrating drift/quarantine behavior is inserted below the top badges.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding a teaser GIF at the top of the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/film-embed

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.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
README.md (1)

9-9: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick win

Pin the banner asset to a release tag.

Hotlinking main makes 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

📥 Commits

Reviewing files that changed from the base of the PR and between c10538f and c346886.

⛔ Files ignored due to path filters (1)
  • docs/assets/covenant-film.gif is excluded by !**/*.gif
📒 Files selected for processing (1)
  • README.md

@Mhemd139
Mhemd139 merged commit dd1ba89 into main Jul 25, 2026
5 checks passed
@Mhemd139
Mhemd139 deleted the docs/film-embed branch July 25, 2026 22:38
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