CONTENT CREATION

Keep ReadMe API reference in sync with code releases

On each tagged release the agent diffs your API surface against your ReadMe docs and, when endpoints or parameters changed, pushes updated reference pages and posts the summary…

CategoryContent Creation
Enginepaperclip
Difficultyintermediate
Triggerevent
Steps6
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerNew release taggedGitHubGitHub
  • ActionFetch release diff and API changesGitHubGitHub
  • ActionPull matching ReadMe reference pagesReadMeReadMe
  • LogicGate: did any endpoint or field change?
  • ActionUpdate affected ReadMe pages and examplesReadMeReadMe
  • OutputPost updated-pages summary to SlackSlack

What it does

Triggers on a new tagged release, inspects what changed in your API code, and reconciles it against the published API reference in ReadMe. When endpoints, request fields, or response shapes have shifted, it updates the matching ReadMe pages and tells your team what moved.

When to use it

Use it when you ship an external API documented in ReadMe and your reference pages quietly fall behind each release. Ideal for developer-platform teams who treat the docs site as a product and cannot afford wrong examples.

How it works

  1. 1A new GitHub release tag fires the trigger.
  2. 2The agent fetches the release diff and identifies API-surface changes.
  3. 3It pulls the current matching pages from ReadMe.
  4. 4A decision step gates on whether any documented endpoint or field actually changed.
  5. 5For real changes it rewrites the affected ReadMe reference pages, including request and response examples.
  6. 6It publishes the updated pages to ReadMe.
  7. 7It posts a Slack summary of every page touched so docs owners can verify.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect GitHubRepos, issues, pull requests, actions.
  2. 2
    Connect ReadMeAPI docs, changelog, auth.
  3. 3
    Connect SlackChannels, DMs, threads, mentions.
  4. 4
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  5. 5
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  6. 6
    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.