Skip to content
markdown-contract

Read a finding, fix the doc

validate-02 · CLI transcript

A document that breaks its contract produces a finding pinned to a source line — open the file at that line and fix it.

Builds on: Check a folder of docs

The artifact

Section titled “The artifact”

A terminal session: the command as you’d run it, followed by the output it prints; trailing comments note the exit status.

Terminal window
# one record dropped its required 'Decision' section
markdown-contract validate ./decisions
Scanned 4 files; 4 matched across 1 contract, 0 unmatched
  decision: 4


D-0007.md:12 error structure/section-missing — required section ‘Decision’ is missing


1 finding(s): 1 error, 0 warn, 0 report
# exit status: 1 (error-level findings)

What it exercises

Section titled “What it exercises”
  • finding line format (path:line level id — message)
  • structure/section-missing
  • exit code 1 (error-level findings)

Continue

Section titled “Continue”