Reference¶
Lookup material: what a thing is, what it defaults to, and what happens when it is wrong. Every page here is checked against the code at the version stated on it — where a page and the code disagree, the code is right and the page is a bug.
What is in this section¶
| Page | Answers |
|---|---|
| CLI reference | Every rtb command and flag, with defaults |
| Cargo features | Which feature enables which module, and what is on by default |
| Environment variables | Every variable the scaffolder reads, and what it falls back to |
.rtb/manifest.yaml |
Every manifest key, its type, and who writes it |
| Presets and markers | What each preset renders, and which marker region owns which edit |
| Validation rules | The exact pattern every user-supplied name must match, and the reserved words |
| What RTB does not do | Deliberate gaps, unimplemented flags, and unsupported combinations |
Which version this describes¶
Reference pages track the workspace version in Cargo.toml — 0.9.0
at the time of writing — and the crate versions the umbrella crate pins
at that version. Where a page describes behaviour that comes from a
standalone toolkit module rather
than from this repository, it says so and links to that module's own
microsite, because that module versions independently.
Where reference stops and explanation starts¶
Reference tells you what the flag is. It does not tell you why the flag exists — that is Explanation — and it does not walk you through a task, which is How-to or Tutorials.