DOCUMENT OPS
Block PRs when the OpenAPI spec drifts from the README
On every pull request that touches your OpenAPI spec, diffs the documented endpoints against your ReadMe docs and posts a blocking check that fails when routes are added…
How it runs
The automated pipeline, trigger to output.
- TriggerPR opened or updated touching openapi.yamlGitHub
- ActionFetch changed spec from PR headGitHub
- ActionPull current documented endpoints from ReadMeReadMe
- LogicDiff spec endpoints against documented set
- OutputPost pass/fail commit status on the PRGitHub
What it does
Guards your developer docs at the moment code changes. When a pull request modifies your `openapi.yaml`, this workflow compares the spec's endpoint set against what your ReadMe project currently documents and reports a pass/fail commit status so undocumented API changes never merge silently.
When to use it
Use it when your team ships API changes faster than docs get updated and you want documentation freshness enforced in CI rather than caught by an angry customer. Best for teams whose source of truth is an OpenAPI file and whose public docs live in ReadMe.
How it works
- 1A GitHub pull_request event fires when the PR touches the spec file.
- 2The workflow fetches the changed OpenAPI spec from the PR head and the current endpoint inventory from ReadMe.
- 3A logic step computes the set difference — endpoints added, removed, or with changed methods that have no matching ReadMe page edit.
- 4If drift is found, it posts a failing GitHub commit status with the offending paths; otherwise it posts a passing status.
- 5The check appears inline on the PR, blocking merge until docs catch up.
Set it up
What you configure once, before turning it on.
- 1Connect GitHubRepos, issues, pull requests, actions.
- 2Connect ReadMeAPI docs, changelog, auth.
- 3Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
- 4Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
- 5Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.
More Document Ops workflows
Narrate new Dropbox PDFs into MP3 audio versions
When a PDF lands in a watched Dropbox folder, extract its text and generate an ElevenLabs voice narration.
On-demand PDF narration via webhook with emailed audio link
Accepts a PDF URL through a webhook, generates an ElevenLabs narration with the requested voice, stores the MP3, and emails the requester a download link.
Triage emailed contract redlines and route by risk
When a counterparty emails a redlined contract, extracts the attachment, diffs clauses against approved templates.
Batch-narrate a Google Drive PDF folder in multiple languages
On a schedule, finds PDFs in a Google Drive folder that lack audio, then generates ElevenLabs narrations in each configured language and files them into per-language subfolders…
Executed Contract Exhibit & Initials Completeness Gate
When a signed contract lands in a Dropbox intake folder, verify every required exhibit, schedule, and initialed page is present.
Draft a negotiation brief from contract clause deviations
An agent reviews a contract against approved templates, researches each deviation.
Run it inside a business
This workflow drops into a full company template. Import the org, and this is one of the playbooks its agents run.
Run this workflow in your colony.
14-day trial. No DevOps. No Sales call. Provisioned in under a minute.