From 07a0d020829670f4ebe4ee7e47368c5de94e34d7 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 10 Jul 2026 15:17:24 +0000 Subject: [PATCH] docs: mark the web analysis wizard and POST /api/analyze as preview (501) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Claude-Session: https://claude.ai/code/session_01W4svt5QTs4WUMSy4HwiVt9 --- README.md | 16 +++++++++++++--- docs/quickstart.md | 7 +++++-- src/medcheck/web/templates/index.html | 11 +++++++++++ 3 files changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e29db37..de05916 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ and generate structured, radiology-style reports — from the CLI, a web UI, or - **Clinical context input** — attach symptoms, trauma history, and suspected diagnosis to guide the analysis - **Professional reports** — structured PDF/HTML/JSON with findings tables, impression, and limitations - **YAML workflow engine** — compose and version-control custom analysis pipelines as code -- **Web UI + CLI + REST API** — 3-step browser wizard, scriptable CLI, and an HTTP API +- **Web UI + CLI + REST API** — scriptable CLI today; the 3-step browser wizard and the HTTP analysis endpoint are a preview — running an analysis from the browser/API is not yet wired up ([#157](https://github.com/Liohtml/MedCheck/issues/157)) --- @@ -53,7 +53,17 @@ docker run -p 8080:8080 \ ghcr.io/liohtml/medcheck:latest ``` -Open [http://localhost:8080](http://localhost:8080) and follow the 3-step wizard. +Open [http://localhost:8080](http://localhost:8080) to browse the web UI (preview). Note that +**running an analysis from the browser is not yet available** — the wizard's Analyze step +returns `501 Not Implemented` until [#157](https://github.com/Liohtml/MedCheck/issues/157) +lands. To run an analysis today, use the CLI inside the container: + +```bash +docker run --rm \ + -v $(pwd)/scans:/data/scans \ + ghcr.io/liohtml/medcheck:latest \ + uv run medcheck analyze /data/scans +``` ### Option 2 — pip install @@ -145,7 +155,7 @@ Run `medcheck analyze --help` for the full list. | Endpoint | Description | |---|---| | `GET /health` | Liveness probe (always public) | -| `POST /api/analyze` | Run an analysis (JSON body: `source`, `anatomy`, `report_format`, `language`, `allow_cloud_llm`, …) | +| `POST /api/analyze` | **Not yet implemented — returns `501`** ([#157](https://github.com/Liohtml/MedCheck/issues/157)). Validates the JSON body (`source`, `anatomy`, `report_format`, `language`, `allow_cloud_llm`, …) and enforces auth/rate limits, but does not run an analysis; use `medcheck analyze` instead | When `MEDCHECK_API_KEY` is set, `/api/*` requires an `X-API-Key` header. Requests are rate-limited per client IP (`MEDCHECK_RATE_LIMIT`, default 10/min). diff --git a/docs/quickstart.md b/docs/quickstart.md index 7ab4737..5d52811 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -56,7 +56,7 @@ medcheck interactive --- -## Web UI +## Web UI (preview) Once the server is running (`medcheck serve` or `docker compose up`), open: @@ -64,4 +64,7 @@ Once the server is running (`medcheck serve` or `docker compose up`), open: http://localhost:8080 ``` -Upload an image, select the anatomy region, and click **Analyze**. Results are displayed as structured JSON and a plain-language summary. +> **Note:** the web wizard is a preview. Running an analysis from the browser is +> not yet available — the Analyze step returns `501 Not Implemented` until +> [#157](https://github.com/Liohtml/MedCheck/issues/157) lands. Use the CLI +> (`medcheck analyze SOURCE`, see above) to run analyses today. diff --git a/src/medcheck/web/templates/index.html b/src/medcheck/web/templates/index.html index 6448630..6252501 100644 --- a/src/medcheck/web/templates/index.html +++ b/src/medcheck/web/templates/index.html @@ -416,6 +416,17 @@

Upload imaging data and run AI-assisted clinical analysis in three steps.

+ +
+ Preview: running an analysis from the browser is not yet available — + the Analyze step currently returns 501 Not Implemented + (#157). + Use the CLI instead: medcheck analyze /path/to/scans. +
+