Documentation
Four kinds of document, because a reader who has nothing running needs something different from a reader who is three months in and wants one fact.
The split is Diátaxis. Only the tutorial is written here; the other three route into keelson's own repository, where the reference is generated and the explanations sit next to the code they explain. Duplicating them on a website is how documentation starts lying.
- 01
Tutorial
for a reader with nothing running yet
One sitting, start to finish: add the dependency, build a statement, read the SQL it produced, run it against a real database, and let the schema generate the rest. Every snippet is lifted from a program that runs in keelson's CI.
read → - 02
How-to
for a reader with something specific to get done
Fourteen tasks, each answered by a program you can run. Composing a filter at run time, mixing in SQL you wrote yourself, deciding who owns the transaction, loading relations without N+1.
read → - 03
Reference
for a reader with a fact to look up
The generated API for all eleven crates, the type × dialect table every backend binds by, and the feature flags that decide what you compile.
read → - 04
Explanation
for a reader with why it is shaped this way
Why each dialect gets its own grammar instead of a shared AST, how a statement becomes SQL, and the execution layer's decisions — each recorded next to the alternative that was rejected.
read →