Skip to content

Example and index consistency

Automax keeps examples, generated plugin lists, runtime pack definitions and documentation navigation aligned with scripts/check-example-indexes.sh.

scripts/check-example-indexes.sh

The check verifies:

  • plugin smoke runbooks against examples/runbooks/RUNBOOK_INDEX.md;
  • the documented builtin plugin list in docs/plugins/index.md;
  • guide pages listed in mkdocs.yml;
  • required runtime validation pack environment files.

Run it before release when examples or plugin documentation change.