CLI reference / product / documentation

stado product documentation

Invocation

stado product documentation [OPTIONS] <COMMAND>

Purpose

Check actual published documentation and GitHub repository policy, or generate a documentation site's search index

Required inputs and options

Input or optionContract
--catalog <catalog>Independent authoritative catalog path
--workspace <workspace>The workspace of canonical checkouts this operation reads and builds from; default WISENT_WORKSPACE, else ~/Documents/CodingProjects/Wisent

Output and state effect

This command group selects one of the subcommands listed below; use its exact child invocation to perform an operation.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.

Subcommands

  • cli-pages — Verify linked command pages and canonical URLs on product websites
  • markdown-policy — Find repository Markdown beyond the root README.md
  • index — Generate search-index.json and the docs/index.html topic cards of a static documentation site from the pages its docs-manifest.json lists; --check writes nothing and fails when either file is stale