Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 1.78 KB

File metadata and controls

37 lines (31 loc) · 1.78 KB

Documentation

The repository README is the user-facing starting point. The documents in this directory have narrower responsibilities so installation, extension contracts, and future plans do not become mixed together.

Current behavior and public contracts

  • Audio capture: microphone + system recording and setup on Windows, Linux, and macOS.
  • Architecture: process boundaries, workers, storage, and the provider registry.
  • Plugin API: how users discover, install, enable, and remove plugins, plus the stable hook reference.
  • Plugin and provider development: package authors, provider contracts, model registration, permissions, tests, and listing submissions.
  • Privacy: local data, network access, credentials, and threat model.
  • Webhooks: outbound event contract, delivery guarantees, signatures, Live agents, security, and rules for future changes.
  • Live AI Assistant: native real-time assistant, independent worker, settings, persistence, API, and resource limits.
  • Local MCP server: read-only desktop-client integration, lifecycle, tools, configuration, and security boundary.

Product direction and research

  • Roadmap: completed foundations and planned work.
  • RAG and MCP analysis: historical design research behind the implemented retrieval and MCP boundaries.
  • AI engine research: model/runtime evaluation notes; not a user guide or stable API.

The root product specification records the original product brief. When it differs from the application or current documentation, the README, source code, and the public contracts above are authoritative.