Customer StoriesReadMe Blog
Guides
Start typing to search…

ReadMe Refactored: Overview and Migration Guide

Overview

We're excited to introduce our new editing experience that brings powerful features including bi-directional Git syncing, MDX support, and a streamlined editing interface. This guide explains what's new, how to migrate your project on your own, and the migration process for Enterprise customers.

What's New

We've refactored every part of ReadMe to support the next generation of APIs, making it easier for people with all levels of technical skills to contribute. Check out the new features and don't miss the full feature list further down—we're just getting started.

ReadMe’s New UI
Create and edit your docs with a new design that brings your content and appearance changes closer to what your users see.
MDX Support
Enhance your docs with interactive components by combining the simplicity of Markdown with the power of JSX.
Bi-Directional Git Sync
Write documentation wherever works best for you, seamlessly syncing between ReadMe and your Git repositories.

See It In Action

Watch the video to get a firsthand look at how the new features work and feel!


Feature Compatibility

We're continuing to release new features for Refactored as we work toward full feature parity, and keep this table updated to notify you of all new updates and improvements. If a feature that you use isn't currently available on the Refactored experience, rest assured that it'll be available soon!

Legacy

Refactored

Additional information

Github syncing NEW

rdme@10 NEW

Requires upgrade from rdme@9 and earlier

Reusable Content

Migrating existing global content coming soon!

MDX Components NEW

Branching NEW

Coming soon!
Feature only includes creating/editing branches and merging. Require review process and comments are not available yet.

Suggested Edits

Not available1

Export Version

Exporting your markdown is now located in the version menu

Export PDF

APIv2 NEW

Requires upgrade from APIv1

OpenAPI/Swagger

API Designer
(Manual API Definition)

objectOfArrays now available!
$refs and reusable object definitions are not supported

GraphQL

LLMs & Ask AI NEW

Owlbot AI

AWS Gateway Integration

Not available1

Localize Integration

This may require an update to your translations after migrating

1 These features are not yet on the new ReadMe UI. Customers who rely on any of these functionalities should not migrate.
Features are actively being worked on and will be available in the new ReadMe UI soon.

Alternative Solutions

If you're currently using features that aren't supported in the new experience, our support team can help you transition to supported alternatives. Please reach out to our support team for assistance in planning your migration strategy.

Migrating On Your Own

If you're currently using any features listed below, your project is not quite ready to migrate. While we're working to build these feature, you can join our waitlist from the migration page accessible through your project's home page.

  • AWS Gateway Plugin
  • Suggested Edits

If you're not using the features mentioned above, you may be eligible for immediate migration! To kick off the process, click on "Migrate to the New Experience" and "Get Started" buttons from your project's Home page and follow the instructions on the next screens.

ReadMe Refactored migration banner

⚠️ Before You Migrate

A few things to prepare for:

  • Most projects migrate in around 10 minutes, but the process may take up to 2 hours depending on the size of your project.
  • Your project dashboard will be temporarily disabled, but your docs will remain live and accessible during the entire process.
  • This update contains breaking changes to our CLI (rdme) and API.
  • Suggested Edits is not supported on Refactored. You will lose access to viewing and merging any existing Suggested Edits.
  • We are migrating your content from Markdown to MDX which may cause the localization integration to treat the content as new, which will require re-translation.
  • This is a non-reversible process. Once you migrate to the new editing experience, you cannot revert to the previous version.
  • Your entire project is being migrated to a Git-backed system.
  • You can contact [email protected] if you have any questions.

Enterprise Users

🚧

Important Note for Enterprise Customers

The new ReadMe experience will be rolling out to Enterprise customers in mid-late 2025. This includes features like bi-directional Git syncing, MDX components, branching and the new editing interface. Once your project is ready to migrate, your CSM will reach out to discuss next steps.

New and Improved Features

You'll have access to all standard features mentioned above plus:

  • Branching including a review and approval process, an upgrade to Staging! (Coming soon)
  • Enhanced team collaboration tools
  • Comprehensive audit logging
  • Enterprise-grade security features

Enterprise Migration

To ensure a smooth and seamless transition for your group, we're gradually rolling out the new experience to enterprise customers. Once we determine your project is ready to migrate, your CSM will reach out to discuss next steps. If you're interested before then and the unavailable features are not a concern, feel free to contact your CSM to see if your group can be migrated at this time.

Need Help?

If you encounter any issues during or after migration:

  • Review our Migration FAQ
  • Contact support through your dashboard
  • Enterprise customers: Reach out to your CSM

Updated 2 days ago