Skip to navigation
ReferenceQualitySkill Behavior ContractsChecking and Review

Lint Documentation Skill in DocsFab

Dev
View as Markdown

The DocsFab lint-documentation skill selects the smallest complete validation set from repository instructions, CI, package scripts, profiles, and file formats. For more information, refer to Checking and Review Skills in DocsFab.

Contract at a Glance

FieldContract
ModeRead-only
Runtime bindingDeterministic-check step in review-documentation, create-documentation, update-documentation, and restructure-documentation
Primary outputExact command evidence, findings, and untested scope
Does not establishTechnical truth, editorial quality, audience understanding, or release readiness

Check Selection and Evidence

Checks can cover syntax, formatting, style, links, metadata, navigation, schemas, builds, rendering, commands, and examples. Each result records the exact command, working directory, assumptions, exit status, relevant output, and untested scope.

A passing check establishes only the rule it exercised. Build success does not prove technical truth. Environment, dependency, network, credential, and tool failures remain distinct from documentation failures.

Boundaries

The skill reports structured findings without editing, scoring, publishing, or performing SCM changes.

Authoritative Sources