RetainAI Documentation

This directory contains the canonical product and engineering documentation.

Documentation map

Concept	Scope
Architecture	Components, boundaries, runtime flow, decisions
Dashboard	Streamlit UI, branding, runtime and deployment
Data	Contracts, schemas, validation, lineage and privacy
EDA	Reproducible exploratory analysis and reports
Modeling	Retention modeling, evaluation and explainability
MLOps	Monitoring, drift, governance and release lifecycle
Multicloud	AWS, GCP, Terraform, DNS, security and operations
Prompts	Prompt contracts, providers, evidence and localization

Recommended reading order

1. Architecture
2. Data
3. Modeling
4. Dashboard
5. Multicloud
6. MLOps
7. Prompts
8. EDA

Documentation principles

describe current behavior
use release language, not temporary iteration language
link to code instead of duplicating it
document security and cost boundaries
separate product capabilities from provider implementations
preserve human review and explainability

Release roadmap

Version	Focus
v0.4	Multicloud product foundation
v0.5	Monitoring and validation
v0.6	Internationalization and provider abstraction
v0.7	Talent context and evaluation
v1.0	Retention Intelligence release

Back to repository README