Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
71 lines (55 loc) · 2.13 KB

DOCUMENTATION_INDEX.md

File metadata and controls

71 lines (55 loc) · 2.13 KB

Janus Documentation Index

This is the shortest path to understanding the current Janus implementation.

Core Reading Order

  1. ../README.md
  2. ../GETTING_STARTED.md
  3. ../START_HERE.md
  4. JANUSQL.md
  5. QUERY_EXECUTION.md
  6. BASELINES.md
  7. HTTP_API_CURRENT.md
  8. ANOMALY_DETECTION.md
  9. QUICK_REFERENCE.md

What Each File Covers

  • JANUSQL.md

    • query structure
    • supported window types
    • USING BASELINE <window> LAST|AGGREGATE
    • how live and historical queries are derived

  • QUERY_EXECUTION.md

    • registration and parsed metadata
    • start_query() flow
    • historical workers
    • live workers and MQTT subscription
    • result multiplexing and runtime status

  • BASELINES.md

    • what baseline bootstrap does
    • LAST vs AGGREGATE
    • async warm-up behavior
    • what state is and is not retained

  • HTTP_API_CURRENT.md

    • current REST endpoints
    • WebSocket result flow
    • request and response shapes
    • persisted query lifecycle status

  • ANOMALY_DETECTION.md

    • when extension functions are enough
    • when baseline state helps
    • recommended query patterns

  • QUICK_REFERENCE.md

    • common local commands
    • query lifecycle endpoints
    • replay endpoints
    • smoke-test flow

Additional Current Guides

Dashboard Boundary

  • Maintained dashboard repository: https://github.com/SolidLabResearch/janus-dashboard

Related Code