Join us on our cross-country
Launch Week 2025!
We're doing a roadtrip between our SF and NYC offices… visiting coworkers, meeting customers and launching new features every stop along the way!
Postman Integration
Postman is the undisputed champion when it comes to testing API calls locally. We have two different Postman integrations we're launching for our first day. Postman has a space vibe, so we're doing our launch from the most out-of-this-world place we would think of: Area 51 in Nevada!
Deploy Collections to ReadMe
The most common way to document your API is with an OpenAPI spec. However, developers are increasingly documenting their APIs right in Postman! Rather than designing in one format and testing in another, by doing it right in Postman you have one source of truth.
We've supported uploading a Postman Collection for a while, but it's a bit cumbersome. Now, we've teamed up with Postman to make a one-click deploy right to ReadMe! So, as soon as you're happy with your API, you can update your public docs.
Sign up for the waitlistRun in Postman
ReadMe has a powerful Try It Now feature, which lets your users make an API call right in the browser. It makes sure your users can get to their first 🟢 200 in seconds, not hours.
Sometimes, though, your users want all their API testing in one place! We've added the ability to have a "Run in Postman" button in your docs, so your developers can pop open a Postman Collection quickly!
<Postman collectionId="your-collection-id" collectionUrl="your-collection-url"/>MCP Servers
MCP ServersNext up, MCP servers! Now, you can use MCP servers to edit your docs and provide an MCP server to all of your customers. This will help them build on top of your API, without ever leaving their IDE. Because we’re so excited about MCPs, we found a billboard that was on the way to Phoenix to announce our launch.
Turn on MCP servers for your customers!
Developer communities have adopted MCP with the excitement of building tools and complex workflows on top of LLMs. We're excited about MCP, too! It means that API creators can enable developers to build outside of docs with confidence that docs and API remain the source of truth.
Your customers can use MCP servers to not only learn about your API, but also to take action and build with your API even faster. Rather than context-switching between documentation, code editors, and testing tools, developers can work directly within their AI-assisted code editor while having instant access to API documentation.
In ReadMe Refactored under AI ✨ settings, toggle MCP server to generate your MCP server to use with clients like Cursor, VSCode, or Claude Code.
Use our MCP Server!
Not only have we launched this for you and your customers… you, as one of our customers, can use it to modify your docs right from Cursor!
Our favorite workflow is to ask for underperforming pages, which it can do by calling our metrics API to get a list of our worst pages. And then we can ask the MCP server to give us suggestions on how to improve each page's content, based on our BEST performing pages. It works like a charm!
If you want to start using our MCP server, you can add it to Cursor below:
You'll need to include your API key. OAuth support from Cursor is coming soon, though!
Note: This feature is only available to customers on ReadMe Refactored. Self-serve can upgrade from their dashboard. For Enterprise… check back Thursday!
Branching
Branching is here! You no longer have to work around the limitations of traditional staging environments. Now, you can edit, preview, and publish isolated branches. You now have full version control over your docs workflow, right from within ReadMe… or, if you'd rather, GitHub!
This is our most requested feature… ever. And now it's here!
You can continue editing as usual, or opt into a branching workflow when you need more control. If you're familiar with Git, you'll be right at home with branching — it's actually built with Git under the hood!
You can use branches to make changes and review them in a preview environment before they're live, send changes to teammates for review, and make changes across multiple pages. Rather than one staging environment, you can create as many branches as you need and merge only what’s ready. Enterprise users will have granular custom merge permissions for better governance and team workflows.
If you have bi-directional sync set up, branches are mirrored between ReadMe and GitHub. This means you can collaborate in either place, and you don't have to choose between docs-as-code and our editor.
What's Next
Enterprise features: Our staging feature only lets you have one version to be deployed… so branching will make it so you can have as many as you want! For Enterprise specifically, we'll be rolling out advanced management, so you can review branches and choose who has the ability to merge them in. You'll have granular control over what goes out and who has the ability to deploy branches!
Suggested Edits: Many of you love Suggested Edits, so in the future, we'll be rebuilding it on top of branching so external users can make edits to your docs, too.
Note: This feature is only available to customers on ReadMe Refactored. Self-serve can upgrade from their dashboard. For Enterprise… check back Thursday!
ReadMe Refactored for Enterprise
A few months ago, we announced our completely redesigned, rebuilt and refactored experience. It has a completely new UI, is backed by Git, and comes packed with a ton of great features. We’ve been putting the finishing touches on features tailored specifically for Enterprise. And now, we’re excited to officially bring ReadMe Refactored to our Enterprise customers!
What is ReadMe Refactored?
New Editing UI: We've moved all editing and previewing into the same UI, and removed the separate admin dashboard. It’s much snappier and modern, and all editing happens right in the hubs. So, rather than having to jump back and forth, you can edit your docs directly and see how your changes look immediately.
Global MDX Components: You can create more interactive docs with MDX, which is Markdown + JSX. We've also prebuilt a number of components, including Cards, Accordions, Tabs, and Mermaid.js diagrams. With a MDX-powered editor, you can integrate React components and write inline custom code blocks–whatever you imagine!
Bi-directional Sync with GitHub: Some people like using our WYSIWYG editor, while others prefer a docs-as-code approach where it's colocated with the code. Now, you don't have to choose. We have a native b-idirectional sync, so you can work in either place and your content is up-to-date in both places.
How to Migrate
We'll walk you through the new experience, upgrade your content from Markdown to MDX, and make sure everything looks and works just right before launch. We'll work with you on a migration plan that's custom to your workflows and setup.
We'll reach out to you about scheduling this, if we haven't already. Or, you can go into your Enterprise Dashboard and get started from there!
Enterprise-specific features
Along with all the features you already know and love, we've built out some new features just for Enterprise.
GitHub Enterprise support: We support on-prem GitHub installations, so you can use bidirectional sync if you're a GitHub Enterprise Server customer.
Approvals & New Editor Role: We replaced traditional staging with an enhanced version of branching. Before, you could only have one staged version, and everything had to be deployed at once. Now, you'll be able to collaborate on as many branches as you need at a time. With Enterprise, you'll be able to add reviews to branches, and have fine-grained control over who is able to approve and deploy changes.
Oh, and one more thing! OAuth support 🔑
We now have support for OAuth 2.0 in reference guides, so your users can play with your OAuth-protected API right from your docs.
Using it is as simple as documenting it properly in your OAS file, and we'll help your users go through the flow and get a token to make a test API request!
AI Agent and New Layouts
For our final day of launch week in NYC, we have two awesome things we're launching. The first is three new layouts for your docs, and the second is an AI agent which can help you write your docs. And since a lot of you have asked, our features may be AI, but all our billboards in the videos are not!
Today we had two launches, a bit of magic… and a Times Square finale!
New Layouts
We have three new layouts now available, bringing our total up to four!
- Classic: This is our layout we've always had! It has two levels of nav at the top, and is great for complex APIs that use all our features.
- Modern: This layout puts search front-and-center, and tightens things up a bit.
- Compact: If you have a simpler API, this moves all the nav onto one line.
- Sidebar: Or, if you want your content to really shine, you can move all the navigation to the left sidebar.
In addition to these new navigation layouts, you can also now add icons or 👋 emojis to any page! Aside from just looking great, this makes your nav easier for your users to scan.
AI Agent Owlbert
Need help editing docs, cleaning them up or even writing them? Our new AI Agent can help out! Click the AI button on the top right, and tell it what you need to get done.
It really does feel magical. There's a ton it can do, and it works great with branching!
Note: This feature is only available to customers on ReadMe Refactored. Self-serve can upgrade from their dashboard. See what version of ReadMe you're using.