Skip to content

docs: quickstart leads with pip install (match the film) - #10

Merged
Mhemd139 merged 1 commit into
mainfrom
docs/quickstart-pip-first
Jul 8, 2026
Merged

docs: quickstart leads with pip install (match the film)#10
Mhemd139 merged 1 commit into
mainfrom
docs/quickstart-pip-first

Conversation

@Mhemd139

@Mhemd139 Mhemd139 commented Jul 8, 2026

Copy link
Copy Markdown
Owner

The explainer film says the quickstart is pip install covenant-mcp — the README quickstart opened with git clone. Now both surfaces tell one story:

  • Quickstart: pip install covenant-mcpsnapshotcheck against your own server, with the exit-code contract inline
  • Try the demo (new subsection): the clone + editable-install flow, labeled as what it is — the pre-baked example server with drift levers

Docs-only; no code, no version bump. GitHub README is the funnel surface the video points at. (PyPI's copy of the README stays frozen at 0.1.1's build — it updates at the next release, not worth one on its own.)

🤖 Generated with Claude Code

The film and the README must tell the same story: install is pip install
covenant-mcp, point it at your server. The clone flow is the pre-baked
demo with drift levers, now labeled as exactly that.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Mhemd139, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 34 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3b963537-dc07-4b5a-a135-1918a5a2cadf

📥 Commits

Reviewing files that changed from the base of the PR and between df8e93e and f51c991.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/quickstart-pip-first

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.

@Mhemd139
Mhemd139 merged commit 040c682 into main Jul 8, 2026
5 checks 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