When a skill, a genre card or a page disagrees with the specifications, the specifications win, and the other is fixed.
The specifications are the contract. The model comes first: every other spec builds on it and settles one part in detail. They are Markdown files in the repository, outside this library, so their rows link to GitHub.
Come here with a question, not to read front to back. The table below says which file to open.
Which file to open
Find the question you have on the left. The file on the right settles it.
- What a document, a link, a map, the journal or the charter is, and what the gate promises.
model.md - How to write or read a genre card: its settings, fields, parts and sections.
genre-format.md - Why the gate stopped a commit, what a check looks at, and how severe it is by default.
checks.md - What a
foliocommand does, and which files it changes.commands.md - How a pack bundles genres, rules and journal kinds, and how a workflow is written.
pack-format.md - The shape every skill follows: how it starts, its rules, its steps, where it stops.
skill-format.md - What the shell draws around a page, and which components and tokens a page may use.
COMPONENTS.md
The specifications
- The folio model Read first: documents, links, maps, the journal, genres, packs, the charter and the gate, in one contract.
- The genre format How a genre card is written: its settings, fields, parts and sections.
- The checks Every check the gate runs, its settings and its default severity.
- The folio command Every command the skills call, and what each one changes.
- The pack format How a pack and a workflow are written.
- The skill format The shape every skill follows: start, rules, steps, stops, done when.
The shell
- The shell's components What the shell draws on every page, and the components a page may write.
Not here
How to lay a page out, draw a figure or build a comparison is craft, not contract. It lives in the craft/ guides that ship with folio, and folio genre points to them.