DOCUMENT OPS
Turn merged API changes into suggested ReadMe edits
When a PR labeled api-change merges, an LLM reads the diff and the affected ReadMe pages.
How it runs
The automated pipeline, trigger to output.
- Triggerapi-change PR mergedGitHub
- ActionFetch merged diff and affected endpointsGitHub
- ActionRead current affected ReadMe pagesReadMe
- ActionDraft page-specific doc edits with LLMOpenAI
- OutputSave edits as ReadMe drafts for reviewReadMe
What it does
Closes the gap between shipping an API change and writing the docs. On merge of an api-change PR, it feeds the code diff and the matching ReadMe pages to an LLM that produces concrete, page-specific edit drafts — new parameters described, removed fields struck, sample requests updated.
When to use it
Use it when writing docs is the bottleneck, not knowing they need writing. This produces a reviewable first draft so doc owners edit and approve instead of starting from a blank page.
How it works
- 1A GitHub pull_request closed-and-merged event with the api-change label triggers the flow.
- 2The workflow fetches the merged diff and identifies which documented endpoints it touches.
- 3It pulls the current content of the affected ReadMe pages.
- 4An OpenAI step drafts precise edits for each page, grounded in the diff and existing copy.
- 5It creates the updated page content as a draft in ReadMe and notifies the doc owner to review and publish.
Set it up
What you configure once, before turning it on.
- 1Connect GitHubRepos, issues, pull requests, actions.
- 2Connect ReadMeAPI docs, changelog, auth.
- 3Connect OpenAIModels, embeddings, files.
- 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.