This directory documents the application architecture, component contracts and deployment design in English. Contribution and release verification instructions belong in CONTRIBUTING.md. Temporary reviews, audit reports and implementation diaries do not belong here.
Start with local installation, secrets and migrations. The root Getting started gives the shortest path to a working test instance. Use synthetic data locally; the demo guide describes API-only seeding.
| Reference | Contents |
|---|---|
| Environment configuration | Variable reference, defaults, secret provisioning and Compose overrides |
| Database and setup | Docker, six secrets, startup, roles, migrations and isolated tests |
| Authentication | Identities, sessions, setup, invitations, recovery and key rotation |
| Administration | Accounts, promotions, subjects, public settings, course responsibility, journal and versions |
| Frontend/BFF | Pages, cookies, same-origin requests, proxy trust and HTTPS deployment |
| Courses and documents | Content trees, inherited access, private files, quotas, cleanup and backup/restore |
| Timetables | Audiences, annual settings, publication, diagnostics and ICS |
| Kholloscope generation | Preparation, private jobs, group assignment and dated publication revisions |
| Curricula | Competency graphs, permissions, JSON exchange and undo |
| Statistics | Pedagogical indicators, storage and API monitoring |
| Architecture decisions | Why schema and deployment boundaries were chosen |
Subject/site operations are consolidated into administration; document operations into courses.
See also building images with revision metadata.