Skip to content

docs(readme): restructure for newcomers and power users#127

Merged
Liohtml merged 1 commit into
mainfrom
claude/dependabot-maintenance-u1mdmh
Jul 2, 2026
Merged

docs(readme): restructure for newcomers and power users#127
Liohtml merged 1 commit into
mainfrom
claude/dependabot-maintenance-u1mdmh

Conversation

@Liohtml

@Liohtml Liohtml commented Jul 2, 2026

Copy link
Copy Markdown
Owner

README overhaul aimed at attracting both first-time users and experienced contributors:

For newcomers

  • Research-tool disclaimer chip moved to the very top (sets expectations before anything else)
  • Quick Start kept as the "~1 minute" Docker path, followed by a new "Your first analysis" block with three copy-paste CLI examples: fully local (no API key), full cloud analysis with consent, and --interactive
  • Clear pointer to where reports land and how --deidentify works

For power users

  • New Usage section: CLI option reference table (--model, --deidentify, --steps, --workflow, …) and REST API endpoints incl. X-API-Key and rate limiting
  • Configuration rewritten as a complete env-var table (MEDCHECK_RATE_LIMIT, MEDCHECK_MAX_VISION_IMAGES, MEDCHECK_MAX_DOWNLOAD_BYTES, model-ID overrides)
  • New Privacy & Security section summarising the consent gate, no-silent-fallback routing, report permissions and hardening, linking SECURITY.md

For contributors

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

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

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 25 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 Plus

Run ID: ad757eeb-5286-4f90-ac93-6bfc9ffd8273

📥 Commits

Reviewing files that changed from the base of the PR and between f641e9f and 7675f4d.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/dependabot-maintenance-u1mdmh

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.

@codecov

codecov Bot commented Jul 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Liohtml Liohtml merged commit 991f7a3 into main Jul 2, 2026
14 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.

2 participants