stado product documentation index
Invocation
stado product documentation index [OPTIONS]Purpose
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
Required inputs and options
| Input or option | Contract |
|---|---|
--catalog <catalog> | Independent authoritative catalog path |
--root <root> | The site checkout; defaults to the current directory |
--check | Refuse stale files instead of writing them |
--workspace <workspace> | The workspace of canonical checkouts this operation reads and builds from; default WISENT_WORKSPACE, else ~/Documents/CodingProjects/Wisent |
Output and state effect
It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.
Refusals
- Refuse stale files instead of writing them
- 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.