Coming Soon — Join the waitlist

Catch docs drift
before it ships

The DocsCanary GitHub Action detects affected documentation on every pull request and posts a rich summary comment — so your team can update the docs before the code merges.

GitHub Actions native

Zero config

Block or warn

How it works

One YAML block. Instant protection.

Add the action to your workflow file, point it at your API key, and DocsCanary takes care of the rest — automatically on every PR.

PR opened

A developer opens a pull request. The action triggers automatically.

Drift detected

DocsCanary analyses the diff and identifies documentation pages that may need updating.

PR comment posted

A rich summary is posted inline on the PR listing every affected page with severity.

Docs updated

The team reviews the comment, updates docs, and merges with confidence.

Workflow file

Drop it in and go

Add the action to .github/workflows/docscanary.yml. No additional configuration is needed — DocsCanary discovers your repositories and documentation automatically from your connected integrations.

Works with any docs platform
Connects to Zendesk, Intercom, Notion, GitBook, and custom URLs.
Configurable severity thresholds
Block merges on HIGH severity, warn on MEDIUM, or run in report-only mode.
Rich PR comments
Each comment includes page titles, URLs, severity ratings, and a link to the full DocsCanary report.
Status checks
Integrates with GitHub branch protection rules — require docs review before merging.

.github/workflows/docscanary.yml

name: DocsCanary Check
on: pull_request
jobs:
  docs-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check for docs drift
        id: docs-check
        uses: docscanary/check-action@v1
        with:
          api-key: ${{ secrets.DOCSCANARY_API_KEY }}
      - name: Comment on PR
        if: steps.docs-check.outputs.affected-pages > 0
        uses: docscanary/check-action/comment@v1
        with:
          api-key: ${{ secrets.DOCSCANARY_API_KEY }}
          affected-pages: ${{ steps.docs-check.outputs.affected-pages }}
          report-url: ${{ steps.docs-check.outputs.report-url }}

PR integration

What your team will see

DocsCanary posts a structured comment directly on the pull request — no context-switching, no extra tools.

🐦

docscanary-botcommented just now

Bot

DocsCanary detected 3 documentation pages that may be affected by this pull request. Review and update before merging.

Documentation PageImpact

REST API — Authentication

/docs/api/auth

HIGH

SDK Quick Start

/docs/sdk/quickstart

MEDIUM

Webhook Events Reference

/docs/webhooks

LOW

Severity levels

HIGH / MEDIUM / LOW

Pages detected

Per-PR, real-time

Status check

Blocks or warns

Capabilities

Everything you need for docs-safe deployments

Works on every PR

Runs automatically on pull_request events. No manual triggers or configuration needed per repository.

Inline PR comments

Posts a rich, structured comment with each affected page, its URL, impact severity, and a direct link to the DocsCanary report.

Branch protection ready

Use the docs-check status check with GitHub branch protection to require docs review before any PR can merge.

Outputs for scripting

Exposes affected-pages count and report-url as step outputs, so you can compose custom workflows on top.

Health score in CI

Optionally fail the check if the org health score drops below a configurable threshold — keep your docs above your quality bar.

Secure API key auth

Generate a scoped API key from your dashboard and store it as a GitHub Actions secret — never exposed in logs.

Coming Soon

Be the first to know
when it launches

The DocsCanary GitHub Action is in private beta. Drop your email below and we will send you early access as soon as it is ready.

No spam. Unsubscribe any time. We will only email you about early access.

Try the free docs audit Start free trial

Catch docs driftbefore it ships