Rewriting everything is how documentation loses its voice
When you correct outdated documentation at large scale, pages usually get rewritten from scratch. That full rewrite loses the parts that made the page worth keeping: the example someone spent an afternoon getting right, the warning added after a support request, or the wording a customer quoted back to you.
The useful corrections are narrow: one parameter name, one default value, and one step that now happens in a different order. The rest of the page stays as the original author wrote it.
To find that small correction, you read both the code and the page, then you spot the specific sentence that is wrong. That task is harder than regenerating the page. At this level of detail, the agent proposes edits and shows them as a diff that a maintainer can examine in a minute. Nothing is published. The person who owns the page decides.
How the agent is built in Agent Studio
Prompt skills hold documentation ownership, your style guide, and the pages you have deliberately marked as simplified, which must never be corrected for accuracy.
The system prompt requires each edit to be as small as possible, and to quote both the original sentence and the code that contradicts it.
It forbids restructuring, tone changes, and any edit other than a correction. Improvements the agent thinks of go into a note, not into the diff.
If the contradiction cannot be derived from the code provided, the agent leaves the section unchanged. It does not edit from a guess.
The GitHub node supplies the changed code and the documentation source. The Agent Chat node reads both. The specific change is the question.
Suggested edits are submitted as a pull request through the GitHub node, one pull request per page, with the contradiction in the description.
No merge occurs. A Human in the Loop node sends each pull request to the page's owner. Pages marked as simplified never enter the queue.
What this agent is built from
- Prompt skills: ownership, style guide, and the pages deliberately left simplified.
- System prompt: minimal edits, with both the sentence and the contradicting code quoted.
- System prompt: no restructuring, no tone changes. Improvements go into a note.
- System prompt: no edit where the contradiction cannot be established.
- GitHub (Integration): the changed code and the documentation source together.
- Agent Chat (Util): reads both, with the specific change as the question.
- When an ActionFlow is enough: If you only need the sections that a change contradicts to be flagged, build the workflow. Many teams want only the flag.
Frequently asked questions
Start building AI workflows
Create a free account, open a template or a blank canvas, and run your first ActionFlow.
Newsletter
Get product updates
New nodes, agents, and product notes. We send mail only when we have something worth opening.