Documentation

This folder is the maintained repo-truth documentation set for the checked-in project. Each maintained file is scoped to one concern and should describe only behavior that is supported by repository code, configuration, or tests.

How To Use This Folder

• Start with Current Product Scope for the present feature set and hard boundaries.
• Use Local Development for first-time setup, debug paths, and the pre-PR checklist.
• Use Setup And Configuration for local setup, environment variables, and Docker/Compose behavior.
• Use Runtime Architecture for the actual runtime topology, module boundaries, and deployment shape in this repo.
• Use Jobs And Workflow for intake, job states, async execution, review flow, and artifact sequencing.
• Use API Reference for the HTTP surface that is routed today.
• Use Translation And Retrieval for provider modes, prompt templates, retrieval, and enrichment.
• Use Quality And Review for verification states, QA escalation, TMX review, and memory promotion.
• Use Storage And Artifacts for backends, object-key layout, download behavior, and retention.
• Use Operations And Scaling for health checks, logging, and realistic scaling guidance.
• Use Implementation Plan: Verified Next Work and Open Questions only for verified gaps or unresolved decisions.

Maintained Document Map

Document	Scope
Current Product Scope	Current feature scope, supported workflows, and explicit current limitations
Local Development	First-time setup, local run/debug paths, and the pre-PR verification checklist
Setup And Configuration	Local setup, .env variables, verification commands, and Docker/Compose behavior
Runtime Architecture	Actual runtime shape in this repo, module boundaries, runtime components, and core data model
Jobs And Workflow	Intake, job states, sync/async execution paths, review loop, and rerun/cancel/replay behavior
API Reference	Routed HTTP endpoints, supported methods, required fields, and filters
Translation And Retrieval	Provider modes, prompt-template selection, retrieval backends, and language enrichment
Quality And Review	Verification states, QA escalation rules, TMX review contract, and memory promotion behavior
Storage And Artifacts	Storage backends, artifact taxonomy, download URLs, replay package contents, and retention
Operations And Scaling	Health/readiness, logging, current operational baseline, and realistic scaling guidance
Implementation Plan: Verified Next Work	Verified implementation gaps and a pragmatic next-work order
Open Questions	Decisions that are still unresolved from the repo's point of view

Compatibility And Archive Files

These files are retained only so older links continue to resolve:

• Architecture (Compatibility Note)
• Operations And Delivery (Compatibility Note)
• Generated Wiki Snapshot (Archived)

They are not maintained source-of-truth documents.

Documentation Rule

If a statement cannot be confirmed from the repository, it should either:

• be removed from the maintained docs, or
• be moved into Open Questions as an unresolved item.