Quickstart

Three minutes to your first auto-generated documentation PR.

1. Install the GitHub App

Click Install on GitHub in the top-right of the landing page, or visit github.com/apps/docs-keeper-app directly. Choose the repositories you want covered. Public repos are free; private repos need a paid plan.

2. (Optional) Add a config

docs-keeper works out-of-the-box on README.md and CHANGELOG.md with sensible defaults. To control which docs update when which code changes, commit a .docskeeper.yml at the repo root:

enabled: true
mode: pr   # or 'comment' to suggest changes inline on the source PR

docs:
  - { glob: "README.md", kind: readme }
  - { glob: "docs/**/*.md", kind: guide }
  - { glob: "CHANGELOG.md", kind: changelog }

rules:
  - when: { path_glob: "src/api/**" }
    then: { update: ["docs/api.md"] }
  - when: { path_glob: "src/cli/**" }
    then: { update: ["README.md"] }

3. Merge a PR

Merge any PR with non-trivial code changes. Within ~60 seconds, docs-keeper opens a follow-up PR titled docs: update from #<your-pr>with the proposed changes. Review it like any other contribution and merge — or close it if it's off.

4. What happens next

  • Every future merge to the default branch triggers a new run.
  • All drafts pass a 7-rule validation gate — bad outputs get marked needs_review and posted as a comment instead of a PR.
  • Track everything in your dashboard — runs, costs, acceptance rate, and per-repo stats.

Troubleshooting

The bot didn't run after I merged. Check that the App has Pull requestevents subscribed (Settings → Developer settings → GitHub Apps → docs-keeper → Permissions & events). If it's a new App you registered yourself, the box may have been unchecked at install.

It opened a PR I don't want. Either close the PR (no further runs for that source PR) or set enabled: false in .docskeeper.yml to pause the repo entirely.