Haven Documentation¶
Haven is a personal data plane that keeps high-signal conversations, files, and local knowledge searchable without leaving your device. These pages collect the canonical runbooks, architecture notes, and API references.
Start Here¶
- Getting Started — install prerequisites, run the stack locally, and preview docs.
- Haven.app Guide — unified macOS menu bar application for running collectors.
- Repository Overview — tour of the source tree, collectors, and shared tooling.
Architecture & Services¶
- Architecture Overview — system context, data flow, and critical data stores.
- Services — responsibilities and interfaces for each core service.
- Technical Reference — detailed schema, ingestion, and pipeline behaviour.
Collectors¶
- iMessage Collector — collect and index iMessage conversations.
- Local Files Collector — watch directories and ingest files.
- Contacts Collector — sync macOS Contacts and VCF files.
- Reminders Collector — sync macOS Reminders.app data.
- Email Collectors — IMAP and local Mail.app email collection.
Configuration¶
- Configuration Reference — complete guide to environment variables and settings.
APIs¶
- Gateway API — download and explore the OpenAPI contract used for ingestion and search.
- Functional Guide — end-user workflows and platform capabilities.
Reference¶
- Schema Reference — canonical SQL definitions and views.
- Backup & Restore — procedures for snapshots, restores, and retention.
Keeping Current¶
- Contributing — docs-as-code workflow, review checklist, and style guidance.
- Changelog — notable updates to the documentation set and supporting tooling.
Preview the site locally with:
pip install -r requirements-docs.txt
mkdocs serve
The navigation above maps directly to the MkDocs sidebar. Every page cites its source material so future updates can trace back to the primary documents.
Adapted from README.md, .tmp/docs/index.md, and prior notes in documentation/technical_reference.md.