Engineering documentation
This directory is the engineering source of truth. The documentation website reads it through site/src/content/docs, which is a symlink to this directory. Keep YAML front matter on new Markdown pages so the site can build them. Repository-relative documentation links remain readable on GitHub; the site maps them to Starlight routes (including custom slugs) and repository source links at build time.
How Imprint works
Section titled “How Imprint works”Start with the architecture overview, then the subsystems: indexing and retrieval, verifiable source memory, chunking, tagging, embeddings, workspaces (including multi-project source links and the unassigned conversation inbox), the queue, sync, devices and portable project paths, secret redaction and skills and personas.
Using it
Section titled “Using it”Installation, the dashboard, MCP tools, the HTTP API, client integrations, configuration and local helper models. Audio files: multilingual audio ingestion, with local Romanian/English transcription, timestamped source reading and queued imports. Voice: the Echo voice companion, a floating hologram with push-to-talk, optional hands-free listening, streamed local speech and the local chat model. Experimental browser capture: the Chrome extension.
Building and operating
Section titled “Building and operating”Building and releases, Docker and nightly security scanning.
Evidence and measurement
Section titled “Evidence and measurement”Platform validation records what was executed, on which platform, and what remains unverified. The measurements behind retrieval and model choices are in the benchmark assessment and methodology, local model selection and context budgets and cost experiments.
Research and experiments
Section titled “Research and experiments”Explored designs, kept because decisions cite them. They describe what was tried, not current behavior: the voice assistant and floating avatar feasibility study, the PersonaPlex memory prototype (removed, ADR 0118) and the LFM2.5-Audio local voice experiment. The voice feature that shipped is the Echo voice companion.
Decisions and upkeep
Section titled “Decisions and upkeep”Use the ADR index and process for significant decisions. Update the relevant operational docs and ADR index in the same pull request. An implemented decision is recorded as accepted; a proposal is not current behavior.
Validation results belong in the change description and, for release/platform milestones, in platform validation. Never turn an unexecuted checklist into a passing result.