Skip to main content

Developer documentation

Read top to bottom for onboarding; skip ahead only when you already know the layers.

Principles

We document systems, not every type in the repo. Each architecture page follows the same spine:

  1. Purpose — what problem it solves.
  2. Code location — where to open in the tree.
  3. Main interfaces / classes — contracts you actually implement or inject.
  4. Startup / registration — how it wires into DI and bootstrap.
  5. How to extend — concrete steps.
  6. Gotchas — ways contributors break things.

Reading order

StepDoc
1Setup
2Architecture overview
3Layer docs: Core, Infrastructure, UI
4Startup flow
5Dependency injection
6Module system
7Data storage, AI and RAG pipeline
8Contributing, Coding standards, Testing, Release process

Users

End-user docs live under Students (student docs home).