Skip to content

Learn · Rulebooks

What a rulebook holds

The four parts of a published rule pack, and the one rule about versions.

Checked against the product on · written for everyone

A rulebook is a bundle of warning labels with the material that teaches the platform what each label means. Installing one gives your rules more to watch for.

The four parts of a rulebook.
PartWhat it holdsWhat it changes
VocabularyThe groups and the warning labels the pack can apply.Which labels your rules can name.
Teaching textA fragment per label and per group, in the pack’s own domain.How the platform decides a label applies.
Starter rulesPre-wired rules a work area can adopt in one step.What you get on install, before you write anything.
ExamplesGrounding events the platform can consult during a pass.How closely the pack matches the domain it was written for.
Safe by default. A rulebook adds warning labels. The action list stays fixed for every account, so installing a pack from anyone can never grant an action your platform did not already have.

Versions are frozen

Once a version is published, its content is frozen. New work goes into the next version. Your work area stays on the version you installed until you move it, and the move is written to the logbook.

Every published version has a manifest hash. Quoting that hash back returns the exact manifest, which is how an auditor confirms what a rule was reading on a given day.

GET/v1/library/manifests/{hash}

Returns the exact manifest that hash names. This is the audit replay door.

FieldTypeRequiredWhat it is
hashstringYesThe content hash printed on the version.

Returns

{
  "hash": "sha256:7ae1…0f34",
  "canon_id": "cn_01HZX…",
  "version": "2.3.0",
  "manifest": { "vocabulary": { "…": "…" } }
}

The starter rulebook

Every new work area starts with one domain-neutral rulebook installed. It carries the general labels, so a rule can be written before any pack is chosen.