GitHub AI Writer

The GitHub AI Writer keeps your documentation in sync with your codebase by watching your pull requests and proposing updates when code changes affect your docs. It analyzes the diff, identifies new endpoints that need documentation or setup steps that have changed, and drafts the update on a review branch in ReadMe. Your public docs are never modified directly — you review a side-by-side diff and merge when ready, like a PR from a teammate.

Getting Started

1. Go to AI → AI Writer.
2. Authenticate with GitHub and grant access to the repositories you want monitored.
3. Open a pull request in a connected repo. The AI Writer picks it up automatically.

To suspend the AI Writer, toggle it off in your project settings.

Example

A developer opens a pull request that adds a new /payments/refund endpoint to your API. The PR includes the route handler, request validation, and a new RefundRequest schema.

The AI Writer analyzes the diff and:

1. Finds your existing "Payments" guide that documents /payments/charge but has no mention of refunds.
2. Drafts a new section covering the refund endpoint — request parameters, expected responses, and a code example.
3. Updates the "API Overview" page to include the refund endpoint in the list of available operations.
4. Creates a review branch in ReadMe and posts a comment on the GitHub PR with a link to preview the changes.

The developer clicks the link, reviews the proposed documentation in ReadMe's side-by-side diff, edits the code example to add an error handling note, and merges the branch. The public docs now cover the new endpoint before the PR is even merged to main.

If the PR only changes internal logic with no user-facing impact, the AI Writer stays silent.

FAQ