mstalcup/auto-doc

Automatically update or generate documentation when code changes, using LLMs

Trust Signals

name	description	required	default
mode	Documentation mode(s) to run. Options: - "user-facing" — End-user guide (markdown) - "technical" — Technical/API reference (markdown) - "architecture" — Architecture overview (markdown) - "all" — Run all three modes	no	all
openai-api-key	OpenAI API key used for LLM calls	yes	—
openai-model	OpenAI model to use (e.g. gpt-4o, gpt-4-turbo)	no	gpt-4o
docs-directory	Directory where documentation files will be written	no	docs
skip-threshold	Minimum number of changed lines required to trigger a documentation update. Set to 0 to always update documentation.	no	10
commit-docs	Whether to commit and push updated documentation automatically	no	true
commit-message	Commit message used when committing documentation updates	no	docs: auto-update documentation [skip ci]
github-token	GitHub token used to push documentation commits. Pass ${{ secrets.GITHUB_TOKEN }} explicitly from your workflow. Required when commit-docs is true.	no	—
max-files-context	Maximum number of changed files to include in LLM context (avoids token limits)	no	20

name	description
docs-updated	Set to "true" if documentation was updated and committed, "false" otherwise
modes-updated	Comma-separated list of documentation modes that were updated