grabowski
7e642555b4
Phase 4 of docs/RUST_REWRITE.md. Since 2026-10-18 ping-collector (rust/) collects, forecasts, notifies (ntfy + Matrix) and serves the website/API; nothing in production ran the Python service code any more. Removed (~17k lines): the FastAPI app (web_api, schemas, health_check, metrics, postgres_history, forecast_history, thaiwater), the Python RID collector and CLI (water_scraper_v3, main, run.py), the notifier and Matrix alerting (notify, alerting), the multi-backend adapters (SQLite, MySQL, InfluxDB, VictoriaMetrics) with demo databases, models/validators/exceptions/ logging/rate limiter, ml/skill.py (served by Rust now), the migration tooling (api_parity, collector_parity, e2e_notify, install_collector.sh, gen_notify_cases.py, spikes/rust-forecast), Docker/compose/Grafana files, sql/, the release workflow and the docs for all of that. Their tests went with them. Kept in Python: src/ml (training, evaluation harness, export; predict.py as the reference the Rust forecaster is tested against), the HII and RID-dam clients/stores for the archive backfills (their live collectors removed), the backfill scripts, retrain.sh + timer, forecast_parity.py. - PostgreSQL only: src/config.py is database_url() from POSTGRES_* / .env; the stores lost their sqlite/mysql branches (and the 2026-08 column migration). The database tests run against a throwaway schema from TEST_DATABASE_URL (tests/conftest.py pg_url, skipped without it), as the Rust tests do; CI gets a PostgreSQL service. 100 tests (66 without a DB). - The notifier settings moved from src/notify.py into src/ml/export.py; flood_config.json regenerates byte-identical. - tests/test_dashboard.py checks every path the dashboard fetches against ping-collector's router. - Dependencies: fastapi, uvicorn, pydantic, influxdb, pymysql, psutil, schedule, sphinx, pyinstaller, mypy, pytest-asyncio dropped; python-dotenv 1.1.1 explicit (it came in through uvicorn[standard]). - Formatting contract extended to scripts/ and tests/ (reformatted once). - scripts/install.sh is the one installer (fresh host or update, in place in a checkout without touching its ownership): binary, units, uv sync, .env defaults, removes the retired water-monitor.service and any old --alert-check cron job, dry run + forecast check, restart, readiness wait. - Docs, CLAUDE.md, CONTRIBUTING.md, .env.example, Makefile, unit comments and Rust doc comments updated to the Rust service.
56 lines
1.9 KiB
YAML
56 lines
1.9 KiB
YAML
name: Docs
|
|
|
|
# Every relative link / image path in the shipped Markdown (README, CLAUDE,
|
|
# CONTRIBUTING, rust/README, docs/) resolves inside the repo. External URLs
|
|
# are NOT fetched: localhost examples and rate-limited hosts made that gate
|
|
# permanently red, and a 200 proves nothing about a doc anyway. The API
|
|
# reference (/docs, /openapi.json) is generated by ping-collector from its
|
|
# route table and tested in rust/collector/src/web/tests.rs.
|
|
|
|
on:
|
|
push:
|
|
branches: [master, develop]
|
|
paths:
|
|
- "**.md"
|
|
- ".gitea/workflows/docs.yml"
|
|
pull_request:
|
|
paths:
|
|
- "**.md"
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
docs:
|
|
name: Validate documentation
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Relative links and images resolve
|
|
run: |
|
|
python3 - <<'PY'
|
|
import re, sys, pathlib
|
|
root = pathlib.Path(".")
|
|
files = [root / "README.md", root / "CLAUDE.md", root / "CONTRIBUTING.md",
|
|
root / "rust" / "README.md", *root.glob("docs/**/*.md")]
|
|
link = re.compile(r"!?\[[^\]]*\]\(([^)\s]+)(?:\s+\"[^\"]*\")?\)")
|
|
bad = []
|
|
for md in files:
|
|
if not md.exists():
|
|
continue
|
|
for m in link.finditer(md.read_text(encoding="utf-8")):
|
|
target = m.group(1)
|
|
if target.startswith(("http://", "https://", "mailto:", "#")):
|
|
continue
|
|
path = target.split("#", 1)[0]
|
|
if not path:
|
|
continue
|
|
resolved = (md.parent / path).resolve()
|
|
if not resolved.exists():
|
|
bad.append(f"{md}: {target}")
|
|
if bad:
|
|
print("Broken relative links:")
|
|
print("\n".join(" " + b for b in bad))
|
|
sys.exit(1)
|
|
print(f"checked {len(files)} files, all relative links resolve")
|
|
PY
|