This directory contains Architecture Decision Records (ADRs) documenting significant technical and architectural decisions made during the development of Sophikron.
| ADR | Decision |
|---|---|
| 0001 | Stack and component separation |
| 0002 | SQLAlchemy, PostgreSQL roles and Alembic |
| 0003 | Original authentication design, amended by 0004/0005 |
| 0004 | Accounts, capabilities and activity; 0001/0003 |
| 0005 | Installation baseline, configuration and release cache |
| 0006 | Promotions, subjects and courses; 0003 through 0005 |
| 0007 | Private storage and document trust; 0005 |
| 0008 | Groups, timetables and ICS; 0006/0007 |
| 0009 | Two Compose files and proxy trust |
| 0010 | Private kholloscope jobs, publication and dated revisions |
| 0011 | Shared curricula, competency graphs and portable subject files |
ADR numbers identify decisions, not migrations. The migration head is 0009_curricula.
See the migration inventory.
An ADR records:
- The context and problem behind a decision.
- The options considered.
- The decision made.
- The consequences and trade-offs.
Use sequential numbers and descriptive names:
0001-short-description.md
Create an ADR when a decision significantly affects the architecture, security, maintainability, deployment or future development of the project.
Small implementation details do not require an ADR.
Each ADR should indicate its status, such as Proposed, Accepted, Deprecated or Superseded.