Skip to main content

/documentation:sync-cli

Sync CLI reference documentation from the runbooks Click command registry to the CloudOps MkDocs documentation site. Preserves hand-curated content marked with <!-- HAND-CURATED --> markers.

Benefits

  • Automated CLI docs generation from Click command registry
  • Hand-curated content preservation (Mermaid diagrams, persona examples)
  • Build validation after sync

When to Use

AttributeDetail
PersonaFrontend/Docs Engineer (FDE)
TriggerNew CLI commands added or existing commands updated
Business ValueKeep docs site in sync with actual CLI capabilities
FrequencyEvery release

Example: As a docs engineer, after a new runbooks release adds 5 CLI commands, I run /documentation:sync-cli to generate docs pages while preserving my hand-curated workflow examples.