Skip to content

Generated Documentation

⚠️ DO NOT EDIT FILES IN THIS DIRECTORY MANUALLY

This directory contains auto-generated documentation from code. All files are generated by the mooncake docs generate command.

Files

  • actions.md - Platform support matrix, action capabilities, and action summaries
  • presets.md - Examples from all preset files in the repository (330+ presets)
  • schema.md - YAML schema reference from Go struct definitions

How to Update

Documentation is automatically generated from code. To update:

# Regenerate all documentation
make docs-generate

# Or use the command directly
mooncake docs generate --section all --output docs-next/generated/actions.md
mooncake docs generate --section preset-examples --output docs-next/generated/presets.md
mooncake docs generate --section schema --output docs-next/generated/schema.md

CI Integration

Documentation freshness is checked in CI:

  • Pull Requests: CI fails if docs are out of sync
  • Pre-commit Hook: Automatically regenerates docs before commit
  • Manual Check: Run make docs-check to verify

Setup Pre-commit Hook (Optional)

To automatically regenerate docs before each commit:

./scripts/setup-hooks.sh

This will install a git hook that: 1. Detects Go/YAML changes 2. Regenerates documentation 3. Stages updated docs automatically

Why Generated?

Generated documentation ensures: - ✅ Never out of sync - Generated from source of truth - ✅ Correct syntax - Validated by parsers - ✅ Always current - Updates with code changes - ✅ No manual maintenance - Zero effort to keep current

Source Files

This documentation is generated from:

Generated File Source
actions.md internal/actions/*/handler.go (action metadata)
presets.md presets/*/preset.yml (actual preset files)
schema.md internal/config/config.go (Go struct definitions)

Generation Details

  • Generator: internal/docgen/ package
  • CLI Command: mooncake docs generate
  • Makefile Target: make docs-generate
  • CI Job: .github/workflows/ci.yml (docs-check)

Timestamps

Each file includes generation metadata: 

<!-- Generated by mooncake docs generate -->
<!-- Version: dev | Generated: 2026-02-09 15:52:37 CET -->

This allows tracking when docs were last generated and by which version.