ishwar-prog/DocSync

Auto-detect documentation drift and generate updated docs when PRs change your code

Trust Signals

name	description	required	default
github-token	GitHub token for API operations (creating PRs, posting comments). Use the automatically provided GITHUB_TOKEN secret. Requires permissions: pull-requests:write, contents:write.	yes	${{ github.token }}
groq-api-key	Groq API key for AI documentation generation. Get a free key at console.groq.com. If not provided, DocSync will detect drift but skip AI generation.	no	""
anthropic-api-key	Anthropic API key for Claude-powered documentation generation. Takes precedence over groq-api-key if both are provided.	no	""
drift-threshold	Drift score (0-100) above which DocSync opens a companion PR. Higher = stricter. Recommended: 70-80 for most projects.	no	75
config-path	Path to docsync.yaml config file relative to repo root. Defaults to docsync.yaml in the repository root.	no	docsync.yaml
open-companion-pr	Whether to automatically open a companion PR with updated documentation. Set to 'false' to only report drift without opening PRs (useful for repos that prefer manual documentation updates).	no	true
post-comment	Whether to post a drift report comment on the triggering PR. Disable if you prefer silent operation.	no	true

name	description
drift-score	The repository drift score (0-100). 0 = docs in sync, 100 = maximum drift.
drift-detected	true if drift was detected above the threshold, false otherwise.
companion-pr-number	The PR number of the companion documentation PR, if one was created.
companion-pr-url	The URL of the companion documentation PR, if one was created.
files-analyzed	Number of JS/TS files analyzed in this run.
constructs-found	Total number of functions, classes, and routes found.