ReadMe Refactored

Gregory Koberger -

Over the past year, we’ve been reimagining, reinventing and refactoring every single part of ReadMe. And now, it’s here!

New Editing UI

We've moved all editing and previewing into the hubs, 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 affect your end developers.

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 – the limit is your imagination!

Bidirectional Sync with GitHub

Everyone on your team has a different preference on where to write docs. Some people like using our 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 bidirectional sync, so you can work in either place and your data is kept up-to-date in both places.

(We currently support only GitHub, but will be adding other providers soon!)

My Developers

Behind every API call is a real person trying to do real things, and we want to give you the tools to help each of your developers. If it’s a developer's first time using your API, they want a nice getting started guide and their API key so they can make their first successful request. But if it’s their 100th time on your docs and the API is down, they’ll need a different experience.

As the third part of our new experience, My Developers helps you understand where each individual developer is in their journey and help move them forward. You’ll be able to learn how developers interact with your API and reach out to them if they get stuck.

Our goal has never been simply to be the best place on the internet to write paragraphs of text. Great documentation isn’t about overloading developers with information; it guides them to 🟢 200s with ease. We’re excited to make APIs easier to use with the new ReadMe. 

We’ve started rolling out an upgrade flow, so check your dashboard to learn how to get started! If you're an Enterprise customer, your CSM will be reaching out soon with details on how to access Refactored Enterprise in early 2025.

If you want to catch up on the launch and see product demos, tune in here for a 15-min announcement (my cohost for this might be an owl). We’re excited to hear what you think about the new ReadMe, so feel free to reach out to our team directly at support@readme.io or say hi in our Slack community!