Skip to main content

Documentation Validation

Thermocline docs include automated truth checks against the sibling thermocline repository.

Run​

npm run validate:truth

If Thermocline runtime source is not in the default sibling path, set:

THERMOCLINE_REPO_ROOT=/path/to/thermocline npm run validate:truth

What It Validates​

  1. docs/reference/compatibility.md body exactly matches source thermocline/docs/COMPATIBILITY.md.
  2. docs/reference/supported-operations.md includes every command in gateway list_commands_catalog().
  3. docs/plugins/ml-engine.md includes all storage-engine ML stages and canonical model types.
  4. Every sidebar doc ID in sidebars.ts resolves to an existing page.
  5. Code path references in docs resolve to real files in the runtime or website repo.
  6. Workstation-specific absolute paths (for example /path/to/...) are rejected.
  7. Every environment variable in docs/reference/configuration-ref.md exists in compose/config-parsing source.
  8. Every docs page (except docs/reference/compatibility.md, which is exact-synced) includes source-of-truth references.
  9. Every make <target> command shown in docs resolves to an actual target in Makefile.

Validator Location​

  • scripts/validate_docs_truth.py
npm run validate:truth
npm run build