DocGuard

Catch Stale

Docs

Early.

DocGuard reads every pull request and points to the exact sentences in your docs that the code change made wrong.

Sign inPublic repositories only. Include private repositories
Cut, the editing agent, as a red plush character in glasses
Hue, the color agent, as a green checked plush character in sunglasses
Nova, the generation agent, as a magenta plush character
Echo, the sound agent, as a red plush character in a blue cap
Flow, the motion agent, as a red plush character with a bow tie

DocGuard

reads

your

diff,

finds

changed

settings,

links

the

docs,

checks

each

claim,

asks

Qwen

and

suggests

every

single

fix.

DocGuard Mascot
app.docguard.ai/scan

Built to run anywhere

Fast, private documentation intelligence.

Rules settle the clear cases, and a local open model handles the confusing ones. No paid AI APIs, zero code leaving your laptop.

SCAN TIME PER PR

< 30s

SCAN TIME PER PR

< 30s

SCAN TIME PER PR

< 30s

MODEL PROVIDER

Qwen 2.5

MODEL PROVIDER

Qwen 2.5

MODEL PROVIDER

Qwen 2.5

YOUR CODE STAYS

On-Prem

YOUR CODE STAYS

On-Prem

YOUR CODE STAYS

On-Prem

Workflow

Four steps from code diff to truthful docs.

DocGuard automates documentation testing right in your GitHub pull request flow.

01
CI Action

Connect

+ Open
01
Step 1 · Setup

Add DocGuard to your repository

Install the native GitHub Action in your CI or connect public and private repositories in one click from the dashboard.

  • Zero configuration or complex token setup
  • Native reusable GitHub Action for your CI
  • Runs securely on every pull request
github.com/marketplace/actions/docguard
02
PR #42
+24 lines-8 lines

Scan PR

+ Open
02
Step 2 · Trigger

Inspect every pull request diff

Whenever code is pushed, DocGuard reads the modified files, detects changed configurations, parameters and defaults, and correlates them to docs.

  • Scans Python code against Markdown and RST
  • Finds renamed flags, defaults, and API routes
  • Lightweight pipeline executes in seconds
github.com/org/repo/pull/42
03
Drift Alert

Detect Drift

+ Open
03
Step 3 · Verify

Pinpoint stale documentation

DocGuard highlights the exact sentence, table row, or parameter value that became outdated, with zero false alarms on changelogs and release notes.

  • Flags outdated defaults, timeouts, and env vars
  • Links directly to the line of code that caused drift
  • Skips changelogs where old values belong
app.docguard.ai/scan/results
04
fix.md

Auto-Fix

+ Open
04
Step 4 · Resolve

Fix docs with one click

DocGuard generates the exact patch needed to sync your documentation. Review the proposed change and commit it directly to the branch.

  • Ready-to-merge doc diffs in PR comments
  • One-click commit to the active branch
  • Guarantees docs remain perpetually true
github.com/org/repo/pull/42#review

What it catches

The changes that quietly break docs.

Each one links back to the line of code that caused it, so a contributor knows exactly what to update.

Flags

Renamed or removed flags. Use --timeout still in the README after it became --deadline.

Flags

Renamed or removed flags. Use --timeout still in the README after it became --deadline.

Defaults

Changed defaults. A docs table that still says 3 when the code now says 5.

Defaults

Changed defaults. A docs table that still says 3 when the code now says 5.

Functions

Renamed functions. Guides that still call the old name.

Functions

Renamed functions. Guides that still call the old name.

Paraphrases

Paraphrased settings. “Requests give up after 30 seconds”, with no setting name in it.

Paraphrases

Paraphrased settings. “Requests give up after 30 seconds”, with no setting name in it.

Routes

Changed routes. API docs still pointing to the old path.

Routes

Changed routes. API docs still pointing to the old path.

And more

Removed parameters, constants and environment variable defaults.

And more

Removed parameters, constants and environment variable defaults.

FAQ

Frequently asked questions.

Everything you need to know about how DocGuard tests code against documentation, prevents false alarms, and runs securely in CI.

Does my code leave my machine?

With the GitHub Action, your code stays in your own CI. The dashboard clones repositories with open pull requests to DocGuard’s server to check them. DocGuard never uses paid AI APIs, and the model runs on hardware we control.

What does it check today?

Python code against Markdown and reStructuredText docs. Changelogs and migration guides are skipped, because old values belong there.

Will it block my pull requests?

No. It reports what it found and leaves the decision to you.

Why does sign-in ask for GitHub access?

To list your repositories and pull requests. Public access is the default, and private access is only requested if you choose it.

How does it avoid false alarms?

A sentence is only reported when there is evidence the change made it wrong. A matching number or a mention of the setting isn’t enough.

For every pull request

Add DocGuard to GitHub Actions in one click.

Pick a repository and DocGuard opens a setup pull request for you. Merge it, and every pull request from then on gets checked. No files to write, no API keys.

  1. Sign in with GitHub and allow DocGuard to open pull requests.
  2. Click Add to GitHub Actions on your repository.
  3. Merge the setup PR. That’s it.
Add to GitHub Actions

Maintainers: less time chasing doc fixes in review. Issues and one-click fix PRs are on your dashboard.

Contributors: no signup. Once a repository has it, you see which sentences your PR made wrong, with a link to fix them in your PR before review. If a project you contribute to doesn’t have it, suggest it to the maintainers.

DocGuard Mascot

Docs that stay true to the code.

Log in with GitHub, import a repository and scan your first pull request.

Create a free website with Framer, the website builder loved by startups, designers and agencies.