Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
103 lines (82 loc) · 3.3 KB

DOCUMENTATION_INDEX.md

File metadata and controls

103 lines (82 loc) · 3.3 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. NESTED_HISTORICAL_SUBQUERIES.md
  8. HTTP_API_CURRENT.md
  9. ANOMALY_DETECTION.md
  10. QUICK_REFERENCE.md
  11. PAPER_BENCHMARKING.md
  12. PAPER_ARTIFACT_MAP.md
  13. PAPER_ARCHITECTURE.md
  14. PAPER_SUBMISSION_PACKAGE.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

  • NESTED_HISTORICAL_SUBQUERIES.md

    • nested historical subquery syntax
    • planning pipeline and diagnostics
    • supported and rejected shapes
    • comparison with explicit DEFINE BASELINE
    • microbenchmark runner

  • 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

  • PAPER_BENCHMARKING.md

    • paper-facing benchmark harnesses
    • current paper claim destinations
    • benchmark output filenames

  • PAPER_ARTIFACT_MAP.md

    • claim to benchmark mapping
    • output files and caveats
    • figure and table destinations

  • PAPER_ARCHITECTURE.md

    • unified execution diagram
    • decomposed Oxigraph baseline diagram
    • nested historical subquery lowering diagram

  • PAPER_SUBMISSION_PACKAGE.md

    • include and exclude lists
    • benchmark artifacts to preserve
    • benchmark artifacts to keep local only

  • 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