Skip to main content

Playbooks

A playbook is a documented run of one chain end to end, with every step a file under apps/docs/examples/. CI lints every step file and runs the steps that run against a local stack; a step that needs a partner's project or real data is linted, not run, and its page says so. A playbook shows what the chain produces and what it does not.

PageWhat it is
Design-partner runbookRun a pre-registered comparison on a partner's own data, and publish what it shows
Security lakeAn OCSF lake to alerts, a Snowflake write-back and a detection-quality report; run by CI
Deposit flightObservation time earned by an ablation, quiet accounts whose risk rises across re-scores, a lead-time backtest and an SR 11-7 dossier; run by CI
PostHog loopBaseline first, a judged model, bands written to PostHog with a holdout withheld; run by CI
Recompute this yourselfReplay a published document's recompute appendix and check every number

Results from a playbook are published in the published-results format (api/jsonschema/published_results.json, with the template apps/docs/templates/published-results.md): the provenance class is in the headline, every number points at an archived artifact by fingerprint, and the document ends with the calls that reproduce it.

Provenance classes​

ClassMeaning
fixtureGenerated or recorded data used to check the machinery. Stays in these docs and CI; it is never presented as a result.
design-partnerA partner's own data, judged under a protocol the partner agreed before the data was built.
productionA customer's live book, judged under a protocol declared before the data it judges.

The class is the one the protocol was declared under. A document never states a stronger class than its protocol.