DOCUMENT OPS
Validate ReadMe code samples against the live API
On a nightly schedule, extracts the request examples from your ReadMe guides, replays them against a staging API.
How it runs
The automated pipeline, trigger to output.
- TriggerNightly at 2am
- ActionExtract request samples from ReadMe guidesReadMe
- ActionReplay each sample against staging APIHTTP webhook
- LogicCompare actual vs. documented responses
- OutputFile a Linear bug per broken sampleLinear
What it does
Catches the subtlest doc drift: examples that still look right but no longer work. It harvests the runnable request samples embedded in your ReadMe guides, executes each against a staging endpoint, and compares the real response to what the docs claim.
When to use it
Use it when broken copy-paste examples are eroding developer trust and reviewing them by hand isn't scalable. Nightly runs surface regressions the morning after they ship, before customers hit them.
How it works
- 1A nightly schedule trigger starts the run.
- 2The workflow pulls all guides from ReadMe and extracts each documented request sample with its expected status and response shape.
- 3An HTTP step replays every sample against the staging API base URL with test credentials.
- 4A logic step compares actual status codes and response shapes to the documented expectations and isolates mismatches.
- 5For each failing sample it opens a Linear bug with the guide URL, the request, and the actual vs. expected response.
Set it up
What you configure once, before turning it on.
- 1Connect ReadMeAPI docs, changelog, auth.
- 2Connect HTTP webhookTrigger any URL on agent actions.
- 3Connect LinearIssues, projects, cycles, triage.
- 4Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
- 5Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
- 6Test, 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.