Read it before you trust it.
Every page here is a file in the repository, rendered at build time, so the words and the code are one commit. The changelog lives beside them.
Using the desk
What a learner needs: how to install it, how to get out of a lock, how to make a class of your own.
- README.mdInstall
Requirements, the installers each release carries, building from source, and what an upgrade from System Design Roulette keeps.
- README.mdEnforcement and the ways out
The three focus policies, the five documented ways out of a locked session, and what to do if a build ever locks you out.
- docs/CUSTOM_CLASSES.mdYour own classes
How a class of your own is built: the brief, the tutor's draft, the editor, the three checks, publishing, and what is underneath.
- docs/WRITING_RULES.mdWriting rules
The rules every generated text is held to, the tells of machine writing the desk reads for, and where each is enforced.
How it is built
The contracts underneath: the runtime, the database, the teacher, the catalogue and the design system.
- docs/SHARED_SESSION_RUNTIME.mdThe shared study runtime
Sessions, stages, preparation ahead of a study time, grading and the import of the old daily routine: the one runtime every lesson runs on.
- docs/STORAGE.mdStorage
The SQLite database, its numbered and checksummed migrations, and the enrollment contracts.
- docs/TEACHER.mdThe teacher
The teacher agent and the mastery ledger every lesson builds on, with what became of each part of the plan it was written as.
- docs/CATALOG.mdThe course catalogue
How a bundled course is authored: the catalogue, the curriculum, the entry map, the diagnostic bank, the reference lessons.
- DESIGN.mdDesign system
The page frame, the type, the three keys and the rules the interface is drawn by.
The project
How to take part, and how to report what should not be public.