01Merged
Pull request
Documentation that follows the product
Keep your docs current after every merge.
DocsUpdater examines what changed, checks the relevant help documentation, and captures the UI states your readers need. You get a Markdown draft and fresh screenshots, ready for review.
Read-only repository access. Nothing is published automatically. Invite-only early access.
Example workflow
From a product change to a review-ready update.
02Needs revision
Documentation impact found
Notification settings guide
New schedule controls and delivery preferences are missing from the current guide.
03Ready to review
Documentation draft
notification-settings.md
## Choose when alerts arrive
Set immediate delivery for urgent activity, or choose a daily summary.
[Configure notification schedules →]
Notification settings
Email updates
Daily summary
Every weekday ⌄
How it works
A short path from merge to review.
GitHub sign-in identifies you. Installing the GitHub App gives DocsUpdater access only to the repositories you select.
- 01
Connect your project
Install the GitHub App on the product and documentation repositories you choose. Add a preview or staging URL and, when needed, a dedicated test account.
- 02
Merge a pull request
DocsUpdater can start after a merge, or you can paste a merged pull-request URL and run it manually.
- 03
Review the update
Receive the documentation-impact analysis, Markdown draft, and relevant screenshots. Publish through the workflow you already use.
Security and control
Useful access, carefully contained.
DocsUpdater is designed to prepare a reviewable result—not to make changes on your behalf.
Read-only GitHub access
The GitHub App reads pull requests and repository contents. It does not request repository write permission.
Review before publishing
DocsUpdater never commits files, pushes branches, opens pull requests, or publishes documentation for you.
Protected credentials
Optional test-account passwords are encrypted at rest and supplied through a dedicated secret channel, not placed in the run instructions.
Private artifacts
Generated screenshots and reports are available only to the authenticated owner of the run.
Scoped by design
Use a preview or staging environment with a dedicated, least-privileged test account.
Verified automation
Merged-pull-request webhooks are signature-verified before a run is created.
FAQ
The practical details.
Does DocsUpdater edit or publish my documentation?
No. It prepares a Markdown draft, impact analysis, and screenshots for your team to review and publish using your existing workflow.
What GitHub permissions does it need?
The GitHub App needs read-only access to the selected repositories’ contents and pull requests. GitHub sign-in identifies you; installing the App grants access to the repositories you select.
Can documentation live in a separate repository?
Yes. A project can point to a separate documentation repository and branch.
Does it work with applications that require login?
Yes. You can provide a preview or staging URL and an optional dedicated test account so DocsUpdater can capture authenticated product states.
Can I run it manually instead of after every merge?
Yes. Automatic runs are optional. You can paste a merged pull-request URL whenever you want an update prepared.
DocsUpdater