Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 2.18 KB

README.md

File metadata and controls

31 lines (23 loc) · 2.18 KB

Sift documentation

Welcome to the documentation for Sift, a local-first clinical intelligence desktop app (Tauri + Node + Vite).

Start here

Document Description
Quick start Run the app in a few minutes
Installation Prerequisites, tooling, and first-time setup
Development Day-to-day dev workflow, scripts, and debugging
Configuration Environment variables, settings UI, and LLM endpoints
Architecture How the host, orchestrator, and UI fit together
Build and release Production builds, Windows bundling, sidecars
Troubleshooting Common errors and fixes
Security and compliance Local-only design, data locations, disclaimers
Testing Jest/Vitest, coverage, GitHub Actions CI
Glossary Terms used across the project
Contributing How to contribute and open PRs

Product direction

Document Description
Transform summary Windows medical-office strategy (folder watch, sidecars, local LLM)

Repository root

The top-level README stays a short overview; deeper detail lives in this folder.

Sift