All templates

Automated GitBook Broken Link Audits

Every Monday, WebRun opens your GitBook space, follows the links on every published page, records the ones that fail along with missing images and empty pages, saves the audit as a dated file in Google Drive, and sends the headline count to WhatsApp.

Runs on WebRun · Strict Lockdown policy
Every Monday at 7:00 AM WebRunorchestrates each step
1 GitBook check every published page for dead links
2 Google Drive file the dated audit
3 WhatsApp send the headline count
In short

How do I find broken links in my documentation site?

WebRun walks your published GitBook space every Monday, opening each page and following its links to find dead targets, missing images, and empty pages. It files a dated audit in Google Drive and sends the broken link count, the trend, and the worst pages to WhatsApp.

  • Dead links are found by you, not by a frustrated reader
  • A weekly trend shows whether docs quality is improving
  • Internal failures are separated from vendor pages that moved

Built for technical writers · developer relations · documentation teams · product managers

Step by step

What does WebRun do on every run?

The exact actions WebRun takes, in order - in plain language, so you can adjust anything.

  1. WebRun signs in and gets to work

    Opens gitbook.com in a real browser with your saved login - no setup, no API keys.

  2. 1
    GitBook - check every published page for dead links
    gitbook.com
    WebRun in GitBook: check every published page for dead links
    WebRun opens GitBook to check every published page for dead links.
    • Open your GitBook space and list every published page in the content tree
    • Open each page and follow its internal and external links
    • Record any link that fails, any image that does not load, and any page with no content
    • Note the page each broken link sits on and whether the target is internal or external

    Done when Every published page has been checked and each failure is recorded with its source page.

  3. 2
    Google Drive - file the dated audit
    drive.google.com
    WebRun in Google Drive: file the dated audit
    WebRun opens Google Drive to file the dated audit.
    • Open the documentation audits folder in Google Drive
    • Save this week's findings as a dated file listing page, broken target, and failure type
    • Group internal link failures first, since those are entirely inside your control
    • Keep the previous weeks in place so you can see whether the count is falling

    Done when This week's dated audit file is filed in Google Drive.

  4. 3
    WhatsApp - send the headline count
    whatsapp.com
    WebRun in WhatsApp: send the headline count
    WebRun opens WhatsApp to send the headline count.
    • Send a WhatsApp message to your docs group with the totals
    • Give the broken link count, the missing image count, and the change since last week
    • Name the three pages carrying the most failures
    • Never edit or unpublish a page. Fixes stay a human edit in GitBook

    Done when The docs group has this week's link health message on WhatsApp.

Run settings

How is each run configured?

Starting pageWhere Chrome opens at the start of each run
gitbook.com
ScheduleRuns automatically on this cadence
Every Monday at 7:00 AM
DeliveryHow each run's result reaches you
Link audit summary · WhatsApp
OutputWhat each run produces - A dated audit listing every broken link, missing image, and empty page with the page it sits on, plus a weekly count and trend.
Text
Setup & safety

Secure by default

Connect once, stays signed in

WebRun signs in once and keeps each session in a persistent environment, so every run picks up right where it left off.

Your credentials stay in your own private environment - WebRun never stores your passwords.
Strict Lockdown

Every action is checked against this policy before it runs.

Domains ALLOWLIST
Typed input ALLOW
Shell command BLOCK
File uploads BLOCK
Runs in a contained environment More on policies
Good to know

Questions, answered

Will it edit or publish my docs?

No. WebRun reads your GitBook space and reports what it found. It never edits a page, fixes a link, unpublishes content, or pushes a change, so nothing readers see changes because of this run.

Does it check external links too?

Yes, and it lists them separately from internal ones. Internal failures are yours to fix straight away, while external failures often mean a vendor moved a page, which needs a different decision.

How long does a full space take?

It depends on how many published pages you have, since each page is opened and its links followed. Running it weekly outside working hours keeps it out of the way, and the audit file records exactly which pages were covered.

Put this on autopilot.

Turn it on in minutes - or have our team set it up for you.