CONTENT CREATION

Refresh stale ReadMe doc images in place after a release

On a release it recaptures each documented screen, uploads the new images directly to your ReadMe pages, and posts a summary of which screenshots were replaced.

CategoryContent Creation
Enginesim
Difficultyintermediate
Triggerevent
Steps6
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerGitHub release publishedGitHubGitHub
  • ActionList documented screens and ReadMe page IDsReadMeReadMe
  • ActionCapture each screen via BrowserbaseBrowserbase
  • LogicKeep only changed screenshots
  • ActionUpload fresh images to ReadMe pagesReadMeReadMe
  • OutputPost Slack refresh summarySlack

What it does

When a release ships, this template recaptures every documented UI screen, and for each one that changed it uploads the fresh image straight into the corresponding ReadMe page — replacing the stale screenshot without a code review step. It then posts a Slack summary of exactly which doc images were refreshed.

When to use it

Use it when your docs live in ReadMe and you trust automated recaptures enough to publish them directly, trading review for speed. Best for high-volume, low-risk product screenshots where staleness is worse than an occasional reshoot.

How it works

  1. 1A GitHub release-published event starts the run.
  2. 2The flow lists documented screens and their ReadMe page IDs from the ReadMe project.
  3. 3Browserbase captures each screen on the released build.
  4. 4A diff step keeps only screens whose screenshot changed.
  5. 5For each changed screen, the new image is uploaded to its ReadMe page, replacing the old one.
  6. 6A Slack summary reports the count and names of refreshed screenshots.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect GitHubRepos, issues, pull requests, actions.
  2. 2
    Connect BrowserbaseHeadless browsers, sessions, replays.
  3. 3
    Connect ReadMeAPI docs, changelog, auth.
  4. 4
    Connect SlackChannels, DMs, threads, mentions.
  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.