docs(readme): restructure for newcomers and power users#127
Conversation
- 'Your first analysis' CLI examples (fully local path + cloud path + interactive) right after Quick Start - New Usage section: CLI option reference table and REST API endpoints - Configuration as a complete env-var table (incl. MEDCHECK_RATE_LIMIT, MEDCHECK_MAX_VISION_IMAGES, model-ID overrides) - New Privacy & Security section summarising the consent/deidentify guarantees with a link to SECURITY.md - Contributing section now links good-first-issue / help-wanted labels and the roadmap epic, and lists the exact CI quality-gate commands - Research-tool disclaimer chip moved to the top; GHCR badge added Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014ywk8AWq5mgbeERmvuhcJy
|
Warning Review limit reached
Next review available in: 25 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
README overhaul aimed at attracting both first-time users and experienced contributors:
For newcomers
--interactive--deidentifyworksFor power users
--model,--deidentify,--steps,--workflow, …) and REST API endpoints incl.X-API-Keyand rate limitingMEDCHECK_RATE_LIMIT,MEDCHECK_MAX_VISION_IMAGES,MEDCHECK_MAX_DOWNLOAD_BYTES, model-ID overrides)For contributors
good first issue/help wantedlabel queries and roadmap epic [Epic] Validation & enhancement pipeline stages — improve and verify results before reporting #51, and lists the exact CI quality-gate commands (pytest with 80 % floor, ruff, mypy, bandit)No content was removed — existing sections (features, diagram, models, data sources, workflows, docs table, acknowledgments, license) were kept and tightened.
🤖 Generated with Claude Code
https://claude.ai/code/session_014ywk8AWq5mgbeERmvuhcJy
Generated by Claude Code