Reference

Everything on these pages is generated from source by tools/gendocs.py in the aowlspt repo. Nothing here is hand-written, and nothing here should be edited in place — an edit will be overwritten on the next run, and worse, it will read as authoritative in the meantime.

The generator was written because this project has repeatedly paid for hand-written reference prose that drifted out of date while still reading as authoritative. Where a fact cannot be extracted mechanically, these pages say UNKNOWN rather than guessing.

What is here

• Host configuration flags — every key the host reads, from its call site, with its type, default and read location.
• The C ABI — every abi/aowlspt_*.h, what it owns, its functions, types and constants.
• Mods — every mod, every settings key, every doc comment.
• The mod API — every exported symbol of aowl/src/aowlspt/*.nim, with its signature and the line it came from.
• Automation — the script library: the narrative reference, the generated verb index, and the reference scripts in full.
• The fact store — what has actually been measured about the live client, and the scrubbed full dump.

Regenerating

cd aowlspt
python tools/gendocs.py \
  --out    ../aoughwl.github.io/docs/aowlspt/reference \
  --public ../aoughwl.github.io/public/aowlspt

--check exits non-zero if the output would change, which is what a CI step should run so a source change that invalidates the docs fails loudly instead of drifting silently.

Sidebar

The generator also emits sidebar.json, which .vitepress/config.mjs imports — so a new header or a new mod appears in the navigation without anyone editing the config by hand.