Skip to content

Frontmatter contract

Spacedock reads YAML frontmatter as the machine-readable state of a workflow and its entities. The first officer and dispatched workers write it; you operate through them, not by hand-editing. The field-level contract (names, types, patterns, defaults, invariants) is two machine-checkable schemas.

Workflow README

The workflow README.md frontmatter declares the entity type, the id style, and the stages with their per-stage defaults and gates. The contract is workflow-readme.mdschema.yml, which also specifies the required per-stage body subsections.

Entity

Each entity's frontmatter carries its id, current stage, outcome, and worktree state. The contract is entity.mdschema.yml, which defines the fields, the custom-field policy, the recognized body headings, and the invariants.