AI · ReadMe

Agent ready

Your docs are better
with AI

features

AI that works,
built into your docs

From live answers to automated updates, ReadMe makes your docs as smart as your product.

MCP

Connect your APIs to
AI agents.

{API}

FEA. [01]

AI Agent

Agent that helps write your docs and keeps you in the loop.

FEA. [02]

Automate Doc Updates

Every merged pull request updates
your docs. No manual deploys, no drift.

FEA. [03]

Ask AI

Instant AI answers,
powered by your docs.

FEA. [04]

Agent Analytics

Track customer questions and AI responses in one place.

AGO

QUESTION

How do I create a new user?

What are the rate limits?

How does auth work?

Make a cURL request in Node

FEA. [05]

Customize

Control the model, tone,
and knowledge it uses.

MODELgpt-4o

LANGUAGEForbidden: darn, heck

KNOWLEDGECustom pricing doc

ENDPOINTSapi.example.com only

FEA. [06]

AI Linting

Fix errors and polish content with a
built-in AI Linter.

FEA. [07]

Docs Audit

Enforce voice, terminology, and style guidelines across your docs.

NAME

SCORE

ERRORS

OAuth Workflows

9.0/10

API Migration Guide

9.0/10

Versioning

8.0/10

FEA. [08]

ReadMe CLI Tool

Write docs in your terminal, or
let AI help you out.

FEA. [09]

AI. [01]

Create branches

There are three ways to create a branch:

Navigate to the versions and branches menu. Once there, you can create new branches from a version.
While editing an individual guide, endpoint, etc., instead of clicking Save, you can click Save to Branch.
If you're syncing with GitHub, branches created in GitHub will show up in ReadMe. And branches created in the ReadMe UI will automatically show up in GitHub!

Once your branch is created, you can start writing! Changes will not be live until you merge your branch into a public version.

Switching between branches

You can switch between branches at any time from the version picker in the top-left of the editor. Your draft on the current branch is saved automatically before you switch, so nothing is lost.

Branches are isolated from each other — edits made on one branch won't appear on another until they're merged. This makes it safe to draft major rewrites or experiment with structural changes without affecting your live docs.

BIS|

Edit with AI

Highlight text and apply changes with inline AI

Select text, type an instruction, and Inline AI rewrites, shortens, expands, or fixes it right inside the editor.

Select text and prompt AI in-editor