Reference¶
The lookup tier: what a thing is, what it defaults to, and what happens when it is wrong. Reference pages describe behaviour that is true of the software as it is built today, verified against the source rather than against intent.
What is in the reference tier¶
-
Every command and flag, grouped by verb.
-
Where configuration is read from, in what order, and every key keryx reads.
-
What a reel workspace contains, which files are committed, and which are regenerable.
-
Every environment variable keryx reads, and what reads it.
What reference does not cover¶
- How to accomplish a task. That is how-to.
- Why something works the way it does. That is explanation.
- Learning the tool from nothing. That is tutorials.
- Design records. Specs live on the wiki and are not documentation — nothing here should require reading one.