Psitta documentation
Project README
These documents describe the implementation that currently exists in Psitta.
They focus on the architectural boundaries, runtime flows, persistence model,
and SRS rules needed by a developer entering the project.
Architecture
- Overview — layers, dependency directions, and
application bootstrap.
- UI — the implemented content-rendering
pipeline and its current limits.
- Application — controllers,
application models, and session use cases.
- Domain — the business model and its
boundaries.
- Sessions — lifecycle, scheduling,
pause/resume, and results.
- Exercises — word and sentence
exercise behaviour.
- SRS — how scheduling state is used by
exercises.
- Persistence — repositories,
DAOs, mappers, and transaction boundaries.
- Database — database lifecycle
and version 1 schema.
- Repositories — the APIs
exposed to the application layer.
Mathematics and SRS
Maintenance
Each source document has one primary topic and one compact Mermaid diagram.
Keep statements tied to the current code; planned components should be labelled
as planned rather than documented as existing.
FULL_DOC.md is generated by dart run tools/merge_docs.dart. It should not be
edited manually.
Some documentation was written with AI assistance and reviewed by the project
author.