Skip to content

docs: mark the web analysis wizard and POST /api/analyze as preview (501)#158

Merged
Liohtml merged 1 commit into
mainfrom
claude/dependabot-prs-q6u94z
Jul 10, 2026
Merged

docs: mark the web analysis wizard and POST /api/analyze as preview (501)#158
Liohtml merged 1 commit into
mainfrom
claude/dependabot-prs-q6u94z

Conversation

@Liohtml

@Liohtml Liohtml commented Jul 10, 2026

Copy link
Copy Markdown
Owner

Summary

The 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 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 returning 501 (linking feat: wire the analysis pipeline into the web wizard & POST /api/analyze #157), and show a working docker run … medcheck analyze /data/scans CLI path
  • docs/quickstart.md: Web UI section marked as preview with the same pointer
  • src/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

  • Existing tests pass (uv run pytest) — 200 passed, incl. the CSP/inline-script checks on the modified template
  • New tests added for new functionality — n/a, docs/template notice
  • Coverage does not decrease (uv run pytest --cov-fail-under=85) — 90.25%
  • Linting passes (uv run ruff check .)
  • Type checking passes — no Python changes
  • Pre-commit hooks pass — codespell clean on the changed files

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

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

coderabbitai Bot commented Jul 10, 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: 10 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: 1a01916e-f1bf-46d5-a705-e6c5ab8f9f5a

📥 Commits

Reviewing files that changed from the base of the PR and between b4b032e and 07a0d02.

📒 Files selected for processing (3)
  • README.md
  • docs/quickstart.md
  • src/medcheck/web/templates/index.html
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/dependabot-prs-q6u94z

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 10, 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 109378e into main Jul 10, 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.

[repo-health] High: README/Quickstart advertise the web wizard & POST /api/analyze, but the endpoint is a hardcoded 501 stub

2 participants