docs: mark the web analysis wizard and POST /api/analyze as preview (501)#158
Conversation
…501) README sold the Docker->browser wizard as the primary quickstart and documented POST /api/analyze as 'Run an analysis', but the endpoint is a hardcoded 501 stub — first-time users hit a dead end. README, quickstart and the web UI itself now say so explicitly and point to the working CLI path (including a docker run command that runs an analysis today). The actual pipeline wiring is tracked in #157. Fixes #134 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01W4svt5QTs4WUMSy4HwiVt9
|
Warning Review limit reached
Next review available in: 10 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. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
✨ 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! |
Summary
The README sold the Docker → browser wizard as the primary quickstart and documented
POST /api/analyzeas "Run an analysis", but the endpoint is a hardcoded 501 stub — first-time users following the README hit a dead end. This takes option 2 from #134 (docs honesty); the actual pipeline wiring is now tracked as a feature in #157 (blocked on the #61 path-sandboxing fix).Fixes #134
Changes
README.md: features bullet, Docker quickstart, and REST API table now state that browser/API analysis is a preview returning501(linking feat: wire the analysis pipeline into the web wizard & POST /api/analyze #157), and show a workingdocker run … medcheck analyze /data/scansCLI pathdocs/quickstart.md: Web UI section marked as preview with the same pointersrc/medcheck/web/templates/index.html: visible notice banner above the wizard so UI users learn it before filling in three steps (style-attribute only — complies with the CSP, no inline scripts)Testing
uv run pytest) — 200 passed, incl. the CSP/inline-script checks on the modified templateuv run pytest --cov-fail-under=85) — 90.25%uv run ruff check .)Additional Notes
When #157 lands, the notices added here should be removed (called out in that issue's scope).
🤖 Generated with Claude Code
https://claude.ai/code/session_01W4svt5QTs4WUMSy4HwiVt9
Generated by Claude Code