thecraighewitt/auto-docs
Self-updating documentation system powered by AI. Automatically analyzes code changes and generates documentation updates.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| anthropic-api-key | Anthropic API key for Claude | yes | — |
| config-path | Path to docs-config.json | no | ./docs-config.json |
| staging-url | Base URL for staging site (for screenshots) | no | — |
| auth-method | Authentication method for screenshots (email-password, api-key, cookie, none) | no | none |
| auth-email | Email for email-password auth | no | — |
| auth-password | Password for email-password auth | no | — |
| auth-api-key | API key for api-key auth | no | — |
| auth-cookies | JSON array of cookies for cookie auth | no | — |
| vercel-bypass-secret | Vercel automation bypass secret for protected deployments | no | — |
| dry-run | Skip writing files, just show what would change | no | false |
| skip-screenshots | Skip screenshot capture | no | false |
| create-pr | Create a pull request with the changes | no | true |
| pr-branch | Branch name for the PR (default: auto-docs/update-TIMESTAMP) | no | — |
| pr-title | Custom PR title | no | — |
| github-token | GitHub token for creating PRs | no | — |
Outputs
| name | description |
|---|---|
| docs-updated | Whether any documentation was updated |
| updated-articles | JSON array of updated article paths |
| captured-screenshots | JSON array of captured screenshot paths |
| pr-number | Pull request number if created |
| pr-url | Pull request URL if created |