CONTENT CREATION

Audit Docs for Broken or Missing Screenshots and File GitHub Issues

Crawls all ReadMe doc pages, verifies every embedded screenshot still loads and renders.

CategoryContent Creation
Enginesim
Difficultyintermediate
Triggerschedule
Steps6
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerNightly schedule starts audit
  • ActionEnumerate doc pages and embedded image URLsReadMeReadMe
  • ActionCheck each image URL loads with a valid responseHTTP webhook
  • LogicSplit images into healthy vs broken/missing
  • ActionRecapture live screen as replacement for broken imagesBrowserbase
  • OutputOpen a GitHub issue per broken image with replacementGitHubGitHub

What it does

Finds documentation images that have gone dead — 404s, blank renders, or removed assets — before your readers do. It scans every doc page, validates each embedded screenshot loads correctly, and for each failure files a tracked GitHub issue that includes the offending page, the broken URL, and a candidate replacement captured from the live UI.

When to use it

Use it when image assets get moved, deleted, or rot over time and you need a reliable backlog of exactly what to fix rather than discovering broken images from a customer complaint.

How it works

  1. 1A nightly schedule starts the audit.
  2. 2The flow enumerates all pages and embedded image URLs from ReadMe.
  3. 3Each image URL is checked over HTTP for a valid, non-empty response.
  4. 4A logic step splits results into healthy versus broken or missing.
  5. 5For each broken image, Browserbase recaptures the corresponding live screen as a suggested replacement.
  6. 6A GitHub issue is opened per broken image with the page link, dead URL, and replacement screenshot attached for a maintainer to apply.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect ReadMeAPI docs, changelog, auth.
  2. 2
    Connect HTTP webhookTrigger any URL on agent actions.
  3. 3
    Connect BrowserbaseHeadless browsers, sessions, replays.
  4. 4
    Connect GitHubRepos, issues, pull requests, actions.
  5. 5
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  6. 6
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  7. 7
    Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.

Run this workflow in your colony.

14-day trial. No DevOps. No Sales call. Provisioned in under a minute.