This index separates current operational documentation from historical design records and result templates. Start with the current guides; dated decisions are retained for project history, not as statements of present behavior.
- Repository README — scope, prerequisites, and primary commands.
- Getting Started — shortest local path.
- Janus-QL — the public query surface and validation rules.
- HTTP API — current REST and WebSocket endpoints.
- Query Execution — registration and runtime paths.
- Live Streaming Guide — MQTT and replay setup.
| Topic | Canonical document |
|---|---|
| Query language | JANUSQL.md |
| Window semantics | WINDOW_TYPES_EXPLAINED.md |
| Query lifecycle and execution | QUERY_EXECUTION.md |
| REST and WebSocket API | HTTP_API_CURRENT.md |
| HTTP quick start | QUICKSTART_HTTP_API.md |
| Live MQTT and replay | LIVE_STREAMING_GUIDE.md |
| Replay CLI | STREAM_BUS_CLI.md |
| Historical materialization | NESTED_HISTORICAL_SUBQUERIES.md |
| Baseline compatibility | BASELINES.md |
| Anomaly-query guidance | ANOMALY_DETECTION.md |
| Backend benchmarks | BENCHMARKING.md |
| Paper benchmark harnesses | PAPER_BENCHMARKING.md |
| Benchmark implementation | citybench_congestion_hybrid_scaling.md |
- BENCHMARK_RESULTS.md and JANUS_BENCHMARK_RESULTS_SUMMARY.md contain retained historical summaries. They are not current performance guarantees.
- PAPER_BENCHMARK_RESULTS_TEMPLATE.md is a reporting template, not a results claim.
- docs/decisions/ contains dated architecture and benchmark decisions. Where a decision conflicts with executable code or a current guide, the current guide and code take precedence.
HTTP_API.md and README_HTTP_API.md are retained as compatibility entry points and direct readers to the current HTTP API reference. README.md is the short in-directory index.