From ee5b577f1abed1322feeb433226292fabf40626f Mon Sep 17 00:00:00 2001 From: Gabor Szabo Date: Mon, 18 May 2026 10:20:03 +0200 Subject: [PATCH] docs(repo): refresh stale CLAUDE.md note, document /demo API, align PR template (#144) --- .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++------ CLAUDE.md | 2 +- README.md | 9 +++++++++ 3 files changed, 19 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bd722f42..4a0b09b6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,12 +4,15 @@ ## Type of Change -- [ ] Bug fix (non-breaking change that fixes an issue) -- [ ] New feature (non-breaking change that adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to change) -- [ ] Refactoring (no functional changes) -- [ ] Documentation update -- [ ] CI/CD changes + + +- [ ] `feat` — new feature +- [ ] `fix` — bug fix +- [ ] `feat!` / `fix!` — breaking change (or `BREAKING CHANGE:` in the body) +- [ ] `refactor` — code restructure, no behavior change +- [ ] `docs` — documentation only +- [ ] `test` — test-only change +- [ ] `chore` / `ci` — tooling, CI, or repo hygiene (no version bump) ## Checklist diff --git a/CLAUDE.md b/CLAUDE.md index 032b3bb6..6dad78e3 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -113,4 +113,4 @@ wc -l CLAUDE.md # must stay ≤ 150 ## Learnings -- HEURISTIC_MODE generated this doc (no `docs/_kB/repo-map/` KB). Run `mapping-repo-context` to upgrade fidelity; sections marked `[UNVERIFIED]` in `docs/_base/` need verification. +- HEURISTIC_MODE generated this doc (no `docs/_kB/repo-map/` KB). Run `mapping-repo-context` to upgrade fidelity; sections marked `[ASSUMPTION]` in `docs/_base/` need verification. diff --git a/README.md b/README.md index c27e3676..ff7b7c46 100644 --- a/README.md +++ b/README.md @@ -712,6 +712,15 @@ uv run python scripts/seed_random.py --verify See [examples/seed/README.md](examples/seed/README.md) for detailed configuration options. +### Demo Pipeline + +Drives the end-to-end pipeline (`seed → features → train ×3 → backtest → register → alias → agent`) in-process and powers the dashboard Showcase page. + +- `POST /demo/run` - Run the full pipeline in-process; returns a `DemoRunResult`. Returns `409 application/problem+json` if a run is already active. +- `WS /demo/stream` - Stream one `StepEvent` per pipeline step for the live Showcase page. + +Only one demo pipeline runs at a time (module-level lock). See [docs/_base/API_CONTRACTS.md](docs/_base/API_CONTRACTS.md) for the full `StepEvent` schema, and the [`/showcase`](http://localhost:5173/showcase) page for the browser view. + ### Error Responses (RFC 7807) All error responses follow RFC 7807 Problem Details format with `Content-Type: application/problem+json`: