Release v1.1.0¶
v1.1.0 is a documentation-focused release: a reorganized MkDocs site, GitHub Pages publishing workflow, and a README written for operators and researchers rather than implementation chronology.
There are no core pipeline or modeling formula changes in this release.
Highlights¶
- User-facing docs organized by task (getting started, ingest, dashboards, calibration, alerting, DLQ, exports, operations).
- MkDocs + Material theme, searchable, with Mermaid diagrams where helpful.
- GitHub Actions workflow
.github/workflows/docs.yml— build withmkdocs build --strictand deploy to GitHub Pages on pushes tomain(plusworkflow_dispatch). - CI (
.github/workflows/ci.yml) runsmake docs-checkon PRs and pushes tomain. make release-checkincludes strict documentation build.- README is a concise front door; detailed content lives under
docs/and the hosted site. - Wording and structure favor task and feature names over internal “Phase N” implementation labels in user-facing text (SQL filenames on disk stay as shipped for history).
Migration notes¶
No database or application migrations are required for v1.1.0.
Enable GitHub Pages (manual, once per repo)¶
- Repository Settings → Pages.
- Build and deployment → Source: GitHub Actions.
After the first successful docs workflow run on main, the site is available at:
https://<owner>.github.io/<repo>/
(Exact URL shown in the workflow run and Settings → Pages.)
Validation commands¶
uv sync --extra dev --extra docs
make docs-check
uv run pytest -q
uv run ruff check src tests
SMOKE_NO_COMPOSE=1 bash scripts/smoke_test.sh
make release-check
make version
Optional with Compose:
COMPOSE_INTEGRATION=1 make release-check
make db-doctor
Historical release notes¶
Older milestones remain under docs/release/ (e.g. v1.0.0, v1.0.1) and CHANGELOG.md.