reusable-docs

To generate documentation for GitHub Actions reusable workflows, you need a YAML frontmatter containing name and description. The tool targets workflow_call-enabled workflows and outputs Markdown files to the docs/workflows directory automatically.

Yes, you can document reusable actions defined in action.yml files. The generator processes these definitions and saves the resulting Markdown documentation into the ./docs/actions directory to keep your repository organized.

The best way to include extended resources is by utilizing optional scripts/, references/, and assets/ directories within your GitHub Actions structure. The documentation generator supports reading these directories to enrich the output Markdown.

Generating documentation for GitHub Actions optionally updates an index in docs/README.md. This feature automatically facilitates navigation across your generated workflow and action Markdown files.

To start automating docs for reusable GitHub workflows, you need valid workflow files with workflow_call triggers and a YAML frontmatter specifying name and description. Simply indicate whether you are documenting workflows or actions, then select the files.