Add MkDocs Material documentation site with 40 pages and auto-generated API reference

Sets up a complete documentation website with 7 navigable sections (Home, Getting
Started, User Guide, Architecture, API Reference, Deployment, Development), light/dark
mode, search, code copy, and Mermaid diagram support. API reference pages use
mkdocstrings to auto-generate docs from source docstrings. GitHub Actions workflow
deploys to GitHub Pages on push to main.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Jon Saad-Falcon
2026-02-21 06:09:36 +00:00
co-authored by Claude Opus 4.6
parent 990d7d8a79
commit f75afefcfb
45 changed files with 10822 additions and 0 deletions
+53
View File
@@ -0,0 +1,53 @@
# Telemetry Module
The telemetry module provides append-only recording and read-only aggregation
of inference metrics. Every engine call records timing, token counts, energy
usage, and cost to SQLite via the event bus. The `TelemetryAggregator`
provides per-model and per-engine statistics with time-range filtering.
## TelemetryStore
::: openjarvis.telemetry.store.TelemetryStore
options:
show_source: true
members_order: source
---
## TelemetryAggregator
::: openjarvis.telemetry.aggregator.TelemetryAggregator
options:
show_source: true
members_order: source
### ModelStats
::: openjarvis.telemetry.aggregator.ModelStats
options:
show_source: true
members_order: source
### EngineStats
::: openjarvis.telemetry.aggregator.EngineStats
options:
show_source: true
members_order: source
### AggregatedStats
::: openjarvis.telemetry.aggregator.AggregatedStats
options:
show_source: true
members_order: source
---
## Instrumented Wrapper
### instrumented_generate
::: openjarvis.telemetry.wrapper.instrumented_generate
options:
show_source: true