usedocs keeps a SaaS help center accurate with two loops, and GitHub drives the first one. After you install the GitHub app and pick a repository, usedocs reads each merged pull request and release. If the change touches behavior an article describes, such as a renamed setting, a new limit, or a changed flow, it opens a proposed edit on that article in Doc health and the shared review queue, with the pull request, the files, and the reason attached. Accepting the edit updates the live article and keeps the old text in version history. Separately, a scheduled check reads each live article against the code and website and flags what no longer matches, which catches drift that never went through a pull request. Nothing is published without approval. Optionally, usedocs can comment on pull requests with the docs impact; that is off by default.

Set it up

  1. Open Integrations. In the dashboard, open Integrations and choose GitHub under Docs and code.
  2. Install the GitHub app. Approve the usedocs GitHub app for the repository that holds your product code. It reads code and pull requests; it does not push to your branches.
  3. Read the first drift report. usedocs compares your live articles with the code and lists the ones that no longer match, each with a proposed fix.
  4. Review in one queue. From then on, merged pull requests and releases add proposed edits to Doc health and the review queue. Approve, adjust, or dismiss.

What it does

  • Proposed edits from merged PRs. Each edit shows the pull request, the files involved, and why the article needs to change, so review takes a minute.
  • Release aware. Releases are read the same way, so a batch of changes becomes a batch of proposed edits.
  • Scheduled article checks. Live articles are compared with the code on a schedule, and the ones that drifted get a proposed fix.
  • First drift report. Right after you connect, usedocs reports which articles no longer match the code.
  • Optional PR comments. Turn on a comment that lists the docs a pull request affects. It is off by default.

Good to know

  • Edits are proposed, never published without approval.
  • Unlimited PR screening on Growth under fair use.
  • PR comments are opt in and off by default.
  • Gap drafts can also be published to a docs folder in the repository or to Notion.