Start with the root README to install and run the project. The documents here explain design decisions and operations in more depth.
- Architecture diagrams describe the components and reference Kubernetes deployment currently present in the repository.
- Architecture decision records preserve why the major technical choices were made. Their context sections may refer to code that has since been removed; the status and amendment notes explain whether a decision is still active.
- Privacy model covers consent, retention, export, deletion, and inference-record access.
- Accessibility separates automated checks from the manual keyboard and screen-reader pass.
| Topic | Document |
|---|---|
| Kubernetes deployment and required secrets | k8s/README.md |
| Container builds and release manifests | Container images |
| Database roles, migrations, and rollback | Database migrations |
| Durable job worker | Background jobs |
| Seeded knowledge lifecycle | Seed knowledge |
| Local operator credentials | Demo access |
| Live presentation flow | Demo walkthrough |
| Structured logs and correlation | Trace walkthrough |
| Metrics | Metrics walkthrough |
| Grafana and other observability UIs | Observability dashboards |
| Content-bearing inference records | Inference trace plane |
| Offline evals and MLflow run comparison | Evals |
The demo walkthrough is a record of a specific local deployment and includes dated limitations. Run its readiness checks against the revision being shown before using it as evidence.
BACKLOG.mdtracks implemented, planned, cancelled, and reopened work. It is detailed because tests and task tooling consume its stable identifiers and status fields.
The tenant financing documents under docs/apex/ and docs/clearview/ are
demo knowledge sources loaded through the real ingestion lifecycle. They are
sample business content, not operating documentation.