Complete AI Training
Sign inGet my AI kit

Your job's AI kit

Get your AI kit

Tell us who you are and what you do. We show you your kit right away and email you the link: skills, prompts, AI agents, MCP servers and courses for your job.

500+ jobs ready, and we make a kit for any other job. No payment needed to look.

Share

AI agent for proofreaders

Docs Pull Request Review Agent

Docs contributions that pass build, style, link and terminology checks before the writer's review

Docs Pull Request Review Agent: what goes in, what the agent does and what you get

What it does

Engineers add useful documentation, but the quality varies and the writer ends up fixing style, links and terms by hand. On each docs pull request, this agent builds the site from the branch and checks that it compiles. It then checks the changed files against the style guide, heading rules, link validity and approved terminology. It posts suggested edits as comments, grouped by importance. When the contributor pushes new commits, the agent rebuilds, checks again, clears the items that are fixed and flags new ones. It repeats until the build and the checks pass. The writer reads the final changes and approves the merge. Edge case: a code sample compiles but contradicts the text above it.

How it works

Follow the arrows from top to bottom. The orange dashed arrow is the loop: when a check fails, the agent goes back and tries again.

Start and resultWhat it doesA check on its own workWaits for your OKGoes back and retries
Yes, continueYes, continueApprovedNoNo 1 STARTS WHEN Docs pull request is opened or updated 2 USES A TOOL Build the site from the branch 3 DOES Read the changed files and list changes 4 USES A TOOL Check style rules, headings, links and terminology 5 CHECKS THE RESULT Does the build pass with no broken links? If not: post the errors with fix suggestions. Back tostep 2. 6 DOES Post suggested edits grouped by importance 7 USES A TOOL Recheck after the contributor pushes updates 8 CHECKS THE RESULT Are all blocking items resolved? If not: keep open items and flag new ones. Back to step2. 9 DOES Write a short summary of changes and remainingsuggestions 10 YOU APPROVE Writer approves the merge 11 RESULT Pull request ready to merge
Read the steps as a list
  1. Docs pull request is opened or updated
  2. Build the site from the branch
  3. Read the changed files and list changes
  4. Check style rules, headings, links and terminology
  5. Does the build pass with no broken links?If not: post the errors with fix suggestions. Back to step 2.
  6. Post suggested edits grouped by importance
  7. Recheck after the contributor pushes updates
  8. Are all blocking items resolved?If not: keep open items and flag new ones. Back to step 2.
  9. Write a short summary of changes and remaining suggestions
  10. Writer approves the mergeThe agent waits here for your OK.
  11. Pull request ready to merge

How it decides

Build errors and broken links block a merge. Style and term issues are suggestions unless they break a hard rule in the style guide.

  • Block on build failures and broken links
  • Treat banned terms as blocking
  • Mark style comments as suggestions
  • Check that code samples match the text near them

Make it yours

Every agent is a starting point. You choose these settings for your own situation.

  • Style guide used
  • Blocking versus suggestion rules
  • Terminology list
  • Repositories covered

What keeps you in control

It always asks you first

  • Merging the pull request

Hard limits

  • Never merges on its own
  • Never edits the contributor's branch

It stops when

  • Done: build and checks pass and writer approves
  • Stop: the branch will not build and the contributor does not respond

Set it up

We guide you through the set-up, step by step

Members get the full set-up guide for this agent. No technical skills needed: you copy, paste and upload.

10 minto set it up in your AI
5 AIsChatGPT, Claude, Copilot, Gemini, Grok
  • One set of instructions to paste into your AI, with the clicks for ChatGPT, Claude, Microsoft 365 Copilot, Gemini and Grok
  • The agent then walks you through connecting your own data, one source at a time
  • A downloadable copy with the flow chart, the rules and the full guide
Get access to this agent

An example run

What happensAn engineer's pull request added 3 pages. The build passed, but the agent found 2 broken links, a heading skipping from H2 to H4, and the term endpoint used for gateway. It posted five comments. After the next push, 4 cleared. It found a code sample using a deprecated flag and flagged it. After a third push everything passed, and the writer merged.

More agents for proofreaders