Skip to content

Commit 829e954

Browse files
authored
docs: land CI-green + hello-page screenshots; trim Jaeger placeholder (#28) (#66)
1 parent 4603e90 commit 829e954

3 files changed

Lines changed: 14 additions & 11 deletions

File tree

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,27 +68,30 @@ Required test coverage of 75.0% reached. Total coverage: 98.64%
6868

6969
### CI on a sample PR
7070

71-
Eight backend + two frontend + four security jobs all green on every PR:
71+
Ten jobs across `ci.yml` (eight backend + two frontend) — all green:
7272

7373
![CI status](docs/images/ci-green.png)
7474

75-
> **Capture:** open <https://github.com/constk/harness-python-react/actions/workflows/ci.yml>, click any green run on `develop`, screenshot the job-list panel. Save as `docs/images/ci-green.png`.
75+
The four security-workflow jobs (gitleaks, pip-audit, npm audit, trivy) gate every PR alongside this set; see the [Security workflow runs](https://github.com/constk/harness-python-react/actions/workflows/security.yml).
7676

77-
### Hello page (`docker compose up`)
77+
### Hello page (`npm run dev` / `docker compose up`)
7878

79-
The scaffold's React page hits `/api/v1/health` on load and renders the version + status badge:
79+
The scaffold's React page hits `/api/v1/health` on load and renders the version + status badge. The Vite dev server proxies `/api/*` to the FastAPI backend (target overridable via `VITE_API_PROXY_TARGET`):
8080

8181
![Hello page](docs/images/hello-page.png)
8282

83-
> **Capture:** `docker compose up`, open <http://localhost:5173>, screenshot.
83+
<!--
84+
TODO (#28): one capture left — Jaeger trace.
8485
85-
### Jaeger trace for `/api/v1/health`
86+
docs/images/jaeger-trace.png
87+
With the full stack running (`docker compose up`), hit /api/v1/health
88+
once, then open http://localhost:16686, select service
89+
`harness-python-react`, click the most recent trace, screenshot the
90+
span timeline.
8691
87-
OTel auto-instrumentation produces one span per request, exported via OTLP gRPC to the local Jaeger:
88-
89-
![Jaeger trace](docs/images/jaeger-trace.png)
90-
91-
> **Capture:** with the stack running, hit `/api/v1/health` once, then open <http://localhost:16686>, select service `harness-python-react`, click the most recent trace, screenshot the span timeline.
92+
When the PNG lands in docs/images/, replace this comment with a section
93+
analogous to "Hello page" above.
94+
-->
9295

9396
## Why a harness
9497

docs/images/ci-green.png

27.4 KB
Loading

docs/images/hello-page.png

38.5 KB
Loading

0 commit comments

Comments
 (0)