GitHub AI Writer [Beta]

The GitHub AI Writer watches your pull requests and automatically proposes documentation updates in ReadMe when your code changes affect your docs.

How It Works

1. A pull request is opened or reopened in your connected GitHub repository
2. The AI Writer analyzes the diff and finds documentation that needs updating
3. It drafts changes on a review branch in ReadMe
4. A summary comment is posted on the PR with preview links

Changes are only applied to your public documentation after you review and merge the proposed branch. You review and merge the branch when ready.

What the AI Writer Looks For

The AI Writer is designed to keep your documentation in sync with code changes. It works best when your pull requests contain clear, well-scoped changes. Here's what it detects:

• New features that need documentation: New endpoints, parameters, configuration options, or user-facing functionality introduced in your PR
• Updated configuration or setup steps: Changes to environment variables, dependencies, install commands, or onboarding flows that make existing docs inaccurate
• Deprecated or removed functionality: Deleted features, sunset parameters, or removed support that should be reflected in your docs

💡

Tip: The AI Writer performs best on pull requests with descriptive titles and clear commit messages. If the intent of a change is obvious from the diff, the resulting documentation draft will be more accurate.

If nothing needs updating, the AI Writer stays silent.

What the AI Writer Doesn't Look For

The AI Writer focuses on documentation content, not code quality. It will not:

• Detect bugs or logic errors in your code
• Flag syntax errors, linting issues, or failing tests
• Review code style or suggest refactors
• Generate API reference docs from code comments — it reads your PR diff, not your docstrings
• Catch typos or grammar issues in your existing documentation that are unrelated to the PR

For code-level review, use a dedicated CI/CD tool or code review integration.

Getting Started

1. In your ReadMe project, go to AI Panel → AI Agent Settings → AI Writer GitHub Authorization
2. Authenticate with GitHub and grant access to the repositories you want the AI Writer to monitor
3. Open a pull request in a connected repo — the AI Writer picks it up automatically

🚧

If you already use bi-directional sync with GitHub, the AI Writer is a separate integration. You can use both on the same repository.

You can suspend the AI Writer from your project settings at any time. It will stop monitoring pull requests until you re-enable it.

Reviewing Changes on a Branch

When the AI Writer proposes documentation updates, it creates a review branch inside ReadMe — not a GitHub pull request.

1. Find the branch: After the AI Writer processes your PR, it posts a comment on the GitHub PR with a direct link to the review branch in ReadMe. You can also find open branches by navigating to your ReadMe project dashboard and selecting Branches.
2. Preview and edit: The review branch shows a side-by-side diff of proposed changes. You can edit the draft directly in ReadMe before merging — treat it like a PR from a teammate.
3. Merge into public docs: When you're satisfied, merge the branch from the ReadMe UI. This is a ReadMe action, not a GitHub merge. Your live documentation is updated only at this point.
4. Discard if needed: If the proposed changes aren't useful, you can discard the branch entirely. Your public docs remain untouched.