How this folder is organized, and where to start depending on what you need.
(For running TWAIN locally, see the repo-root README.md.)
Start here if you're new to the project.
| Document | What it is |
|---|---|
GETTING_STARTED.md |
Orientation guide: reading paths by role, repo layout, FAQ |
PROJECT_SUMMARY.md |
Executive overview: what TWAIN is, status, deliverables |
REVIEW.md |
Architecture review: design decisions, gaps, recommendations |
IMPLEMENTATION_ROADMAP.md |
Phased plan, timelines, resource plan |
| Document | What it is |
|---|---|
BACKLOG_OVERVIEW.md |
Kanban-style overview of all epics and stories |
DETAILED_BACKLOG.md |
Full user stories with acceptance criteria and effort estimates |
initial-backlog.md |
The original pre-discovery backlog (historical) |
| Document | What it is |
|---|---|
domain-neutral-agentic-pipeline.md |
The original architecture design document |
pipeline_flow_diagram.md |
Dataflow, state machine, and module-interaction diagrams |
DIAGRAMS_INDEX.md |
Index of the .drawio diagrams and what each shows |
CONFORMANCE_MIGRATION.md |
Mapping of existing code onto the blueprint |
web_ui_plan.md |
Design of the web UI / API / runner stack |
*.drawio |
Editable diagram sources (open with draw.io) |
Architecture decision records; one file per decision
(e.g. schema_versioning.md).
../runner/README.md— runner service: local runs, Docker offload, AWS deploy../api/QUICKSTART.md— FastAPI backend../app/QUICKSTART.md— Expo web app