Metadata

Atoms that name, describe, or tune a block without checking the document: name, id, desc, help, override, maxSeverity.

Chief engineer: She's got more knobs than you'll ever need, Captain.

Quick reference

Examples

name

An author label for the construct, used in docs and diagnostics — name="Release summary". Display only; it never validates the output or changes which heading a section binds to.

A name labels the section without checking anything

contract.mdv.md
<!-- mdv: section required name="Release summary" content.words.min=10 -->
## Mission Summary
document.md
## Mission Summary

Navigation, docking, and telemetry checks all cleared before the morning launch window.

✓ passes

match.heading

Deliberately structural: overrides which heading this section binds to, instead of its own visible heading. Unlike name=, this changes matching, not just display.

block
<!-- mdv: section required match.heading="Plan for Next Week" -->
## Plan for the Week of <Month> <Day>
<!-- mdv: endsection -->

id

A block's stable key, e.g. id=summary: what a child contract's override targets through extends. Kebab-case and unique in the contract; it never changes document matching.

block
<!-- mdv: section id=summary required -->
## Summary
The release ships the new docking checklist and retires the manual pre-flight sheet.
<!-- mdv: endsection -->

override

In a contract with extends=, replaces the base block with the same id= (or, with a warning, the same heading). Replaced whole, in the base block's position.

block
<!-- mdv: section id=summary override recommended -->
## Summary
The release ships the new docking checklist and retires the manual pre-flight sheet.
<!-- mdv: endsection -->

desc

An author description / generation hint for the construct — desc="…". Metadata only; it never validates the output.

A description documents the section without checking anything

contract.mdv.md
<!-- mdv: section required desc="One paragraph the release manager can paste into the changelog" content.words.min=10 -->
## Mission Summary
document.md
## Mission Summary

Navigation, docking, and telemetry checks all cleared before the morning launch window.

✓ passes

help

Author guidance surfaced on this field's validation errors — like a form field's help text (help="…"). Metadata only; it never validates the output.

Help text rides along with the field and checks nothing

contract.mdv.md
<!-- mdv: section required -->
## Release checks
<!-- mdv: list required items.all=checked help="Tick only after the release CI run is green on the merge commit." -->
- [x] CI green
document.md
## Release checks

- [x] CI green
- [x] Docking tests signed off

✓ passes

maxSeverity

Cap every doc-side error at "warn" so a failing check exits 0 - a severity floor the contract author sets deliberately, not a per-rule dial. No gate fails on a clamped finding, so autofix treats the document as passing and does not repair clamped issues; they are left for a human to read and decide. Only "warn" is accepted - "error" would be a no-op, since error is already the ceiling.

A severity cap leaves a clean document clean

contract.mdv.md
<!-- mdv: document maxSeverity=warn -->
<!-- mdv: section required -->
## Summary
document.md
## Summary

Docking rework shipped.

✓ passes

See also: Severity overrides

On this page