SmrtHub Documentation
SmrtHub is a supervised, privacy-first automation fabric that fuses .NET 8 desktop services with a Python 3.12+ intelligence core. Every clipboard capture, screenshot, and document is routed through deterministic pipelines so content lands in the right workspace with the right metadata—zero guesswork, zero shadow data.
- Hybrid runtime: hardened C# apps handle shell integration while Python orchestrates detection, enrichment, and formatting.
- Supervisor-led lifecycle: the Windows host monitors, restarts, and logs every component for predictable recovery.
- Operational discipline: unified logging, centralized config, and governed packaging keep the platform audit-ready.
The documentation set is mid-rebuild. Any section tagged WIP is being actively authored; Planned represents queued topics.
Platform Snapshot¶
- Hybrid execution: WinUI services handle shell hooks, Extract and LLM triggers, and supervisor UX while the Python core runs runtime routing, SmrtDetection, and SmrtSpace policy enforcement via the HTTP bridge.
- Deterministic data flow: ClipboardMonitor, TriggerManager, and extraction feed a single ingestion API; Python workers enrich content, then return artifacts to governed storage defined in the Operational Data Policy.
- Observability-first: Every app emits aligned JSONL + text logs, ships heartbeat telemetry to the supervisor, and can export HTML bundles for support investigations.
Stubbed Installation Content
Distribution guidance is withheld until production packaging is finalized. Developer-only bootstrap steps and ad-hoc exe launching instructions intentionally remain undocumented.
Documentation Roadmap¶
| Area | Focus | What to expect next | Status |
|---|---|---|---|
| Getting Started | Guided supervisor onboarding, environment prep, telemetry opt-ins | Finalize checklist-driven install + first-run validation | WIP |
| Architecture & Spec | Layering model, process map, HTTP bridge contract | Expand mermaid system views + latency budgets | WIP |
| Components | Per-app responsibilities, health contracts, restart semantics | Auto-ingest per-component READMEs with status badges | WIP |
| Operations | Supervisor controls, logging/export procedures, recovery drills | Add “day two” triage playbooks + retention guidance | WIP |
| Policies & Governance | Operational data, package pinning, asset/DPI rules | Link policy READMEs with scenario summaries | WIP |
| Reference | Canonical logging schema, troubleshooting matrix | Publish mkdocstrings-backed API stubs + CLI references | WIP |
| Release Notes | Highlights per packaged build, configuration migrations | Wire in version selector once packaging pipeline stabilizes | WIP |
| Support Playbooks | Support bundle, redaction, escalation workflows | Document guided bundle capture + secure handoff | WIP |
How to Navigate This Site¶
- Start with the Status Table above to understand which sections are authoritative today.
- Jump into Architecture for the canonical SmrtHub specification, component diagrams, and HTTP contracts.
- Use Policies when determining where logs/configs belong or when packaging new builds (NuGet pins, DPI, assets).
- Consult Operations for supervisor commands, support bundle exports, and retention/cleanup automation.
As sections graduate from WIP to stable, the navigation will surface release toggles and per-version callouts. Until then, each page clearly flags gaps or staged content.
Guiding Principles¶
- Unified logging keeps telemetry symmetrical across C# and Python and enables automated support bundles.
- Supervisor-first orchestration ensures deterministic restarts, negotiated shutdowns, and consistent heartbeat cadence.
- Operational Data governance protects user content by enforcing canonical storage locations, naming, and retention.
- Central package management prevents version drift by pinning every NuGet/Python dependency in shared props files.
Current Authoring Priorities (Q4 2025)¶
- Finish the Components index ingestion so each WinUI/Python module summary auto-pulls from its README.
- Align theming tokens with the Smrt.UI palette to ensure screenshots and UI references match the product.
- Backfill mkdocstrings references for Python APIs exposed via the HTTP bridge and supervisor automation hooks.
- Publish troubleshooting matrices that map log signatures to recovery guidance.
Feedback¶
Open an issue in the GitHub repository with the label docs, or annotate the relevant page via the “Edit on GitHub” link. Please include which section you were reading, the build/version you are running, and any screenshots or logs (redacted per policy) so we can prioritize the right updates.