ReadMe

What if the best way for technical writers to use AI is to use just enough of it? That’s the idea behind our new three-part series on using AI as an assistant, not a boss. In Part 1, we’re looking at how AI can help make documentation easier to find and use, for both people and AI tools: • Add AI-powered search, like Ask AI, to help readers find answers faster • Make your docs easier for tools like Claude and ChatGPT to read and understand • Use MCP servers to connect coding tools directly to your docs, so they can work with real API endpoints instead of guessing AI doesn’t replace the institutional knowledge, product expertise, and understanding of your users that technical writers bring to the table. But it can help make that knowledge more accessible. Read Part 1 to learn how to put AI to work in your docs workflow, without letting it take over: https://lnkd.in/egeZi4zS

Your docs are already written somewhere. Now bring them into ReadMe. Drop in a URL, upload an OpenAPI spec, or add your markdown files. Whether you're migrating from a homegrown solution or an existing documentation platform, ReadMe's Importer builds your project automatically.

Who changed that API setting at 2am and why? Audit logs exist to answer that question, and we just rebuilt ours from the ground up. Clearer filters, better visibility, less detective work for your team.

Keeping docs up to date when you're constantly shipping is a pain. A feature launches, a version bumps, and the docs are already stale. The bottleneck was never the writing. It was knowing what needed to change. ReadMe's GitHub AI Writer closes that gap. It watches your pull requests. When a PR changes something that affects your documentation, it reads the diff, drafts the update, and creates a branch in ReadMe. Then it drops a comment on the PR with a link so you can preview the changes. Connect your repo, open a PR, and check for a branch.

We just rolled out a redesigned ReadMe, built around how docs get written and read with AI. Here's what's new: 📐 Redesigned admin experience — Everything lives in a single sidebar now. Settings are reorganized, and there's a full preview mode so you can see exactly what your customers see. ✏️ New editor — We rebuilt it from the ground up. It handles Markdown and MDX, and brings AI right into the editing flow. Highlight text, get suggestions, apply changes without leaving the page. Plus: branching is built in, so you can draft rewrites without touching your live docs. 🤖 AI Writer — When your team pushes code changes to GitHub, ReadMe creates a branch with suggested doc updates for you to review and merge. Docs stay current with product development without the manual chase. 🖥️ CLI tool — Write and lint docs from your terminal. Catches broken links, duplicate slugs, invalid frontmatter, and broken MDX. Auto-fixes most issues, and works with Claude or Codex for the rest.Write from ReadMe's editor, your IDE, or the CLI. Your customers just see great docs.

You're all still repping last year's swag and we love it 💙 Great seeing everyone at Write the Docs. This year's batch is fresh off the printer.

We’re at Write the Docs in Portland this week so swing by to say hi, grab a custom engraved notebook, collect a few pins and a tote bag! 🦉

Private MCP servers in ReadMe now support token-based auth. This is a big one for enterprise teams with private docs. Previously, giving AI tool access to your private API docs meant sharing your API key or setting up a project password. Now you can just add ?token=yourKey to the MCP URL and they're in. Works with Claude, Cursor, or any MCP-compatible tool.

New in the AI Dropdown: MCP connection options 💥 If your project has an MCP server enabled, you can now surface connection options directly in the AI Dropdown. No more sharing MCP URLs separately or pointing people to setup instructions. It's a small surface area change that makes a big difference for discoverability. Check it out in your docs!