Document Authoring

Skill id: document-authoring

Generated from JSON Schema — do not edit by hand. Run bun run cat-harness/scripts/gen-schema-docs.ts.

Input

Input schema for the document-authoring skill: create or revise one content block in a document folio.

FieldTypeRequiredDescription
documentstringyesDocument slug under content/.
chapterstringyesChapter directory name within the document.
sectionstringyesLabel or title of the section whose blocks[] will name this block.
kind"prose" | "example" | "remark" | "algorithm" | "simulator" | "equation" | "diagram" | "table"yesBlock kind. Restricted to the document profile: the seven math kinds (definition, theorem, lemma, proposition, corollary, conjecture, proof) are the paper profile and are rejected by content_profile_check.
labelstringyesStable identifier, e.g. rec:cold-chain-audit. Becomes the block’s HTML anchor; must survive renumbering.
titlestringnoShort display title.
usesarraynoLabels of the blocks a reader must already have read. Direct neighbours only, never the transitive closure. Editorial judgement — never derived.
bodystringnoGitHub-flavoured Markdown for the block’s .md file.

Raw schema · ✎ Edit

Output

FieldTypeRequiredDescription
labelstringyes
filesWrittenarrayyesRepo-relative paths written (.ts and .md).
listedInSectionbooleanyesWhether the block root was added to a section’s blocks[]. False means the block renders nowhere — the most common way authored work disappears.
validationobjectno

validation

FieldTypeRequiredDescription
errorsintegerno
warningsintegerno
profileViolationsintegerno

Raw schema · ✎ Edit


folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev