amfelt docs check

Compares the documentation already committed under the documentation directory named by docs.path against what docs generate would currently produce from the project’s data contracts and configuration, without writing anything. It runs the exact same safety checks docs generate does — refusing a hand-written Markdown page, a symbolic link, or a directory containing its own .git repository — so a refusal here means docs generate would refuse too. Intended for CI: it reports the outcome and sets the process exit code, so a pull request that changes a contract without regenerating its documentation can be caught before merge.

A project with docs.enabled set to false is reported and left alone — a project that never opted in cannot be out of date. Otherwise, every changed, missing and orphaned page is listed by path, and the command exits non-zero if any are found. A protected region whose content would be dropped is reported as a warning either way, since that prose exists nowhere but the page and git history.

Usage  

amfelt docs check [flags]

Examples  

docs check
Verifies that the documentation for the project in the current directory matches
its current data contracts and configuration.

docs check --path pcf/PCF-postgres.yaml
Verifies the documentation for the project defined by the given project file.

Flags  

Global flags  

See also  

• docs — the parent command

Generated from amfelt v5.6.3.