Skip to content

mooncake docs

Generate documentation from action metadata

Description

Generate documentation from action metadata to keep docs in sync with code.

Single-section emitters (--output is a single markdown file): - platform-matrix: Platform support table for all actions - capabilities: Action capabilities table (dry-run, become, etc.) - action-summary: Detailed action summaries grouped by category - action-properties: Properties tables from schema.json (auto-generated) - preset-examples: Examples from actual preset files (validates syntax) - schema: YAML schema from Go struct definitions - all: Concatenated platform-matrix + capabilities + action-summary + schema

Multi-file emitter (--output is a DIRECTORY): - all-into-dir: Per-action cards + schema + properties + matrices + preset examples, written into the output dir as a structured tree ready for MkDocs (mkdocs reads dist/docs/) and llms.txt agent consumption.

Examples: mooncake docs generate --section platform-matrix mooncake docs generate --section all-into-dir --output dist/docs mooncake docs generate --section action-properties --output dist/docs/properties.md mooncake docs generate --section preset-examples --presets-dir ./presets

Flags

Flag Type Default Description
--help / -h bool false show help

Subcommands

  • generate — Generate documentation sections