Identify Your ReadMe Version and Plan

We’ve recently introduced ReadMe Refactored, a redesigned and re-architected version of ReadMe. This update brings a modern editing experience, Git-based workflows including branching, and MDX custom components.


💁‍♂️

If you’re editing docs from dash.readme.com (in your address bar)—you’re on the legacy version of ReadMe.


Your Plan

  • Self-serve: If you manage 1 project, or projects individually.
  • Enterprise: If you have access to an Enterprise dashboard or you’re using enterprise features like SSO.

Still not sure? Reach out to our team and we’ll help you out!


What’s next?

If you’re on a legacy project, you can migrate to Refactored. Watch a demo of the new ReadMe (4 min).


ReadMe Refactored Project

Refactored projects have an admin bar at the top. This is how you’ll access Settings, Versions and Branches, View, Edit, My Developers, and AI.

Legacy Project

Legacy project docs are edited from the dashboard at dash.readme.com.


Feature Compatibility

LegacyRefactoredAdditional information
Layout Themes NEW
Github syncing NEW
Branching NEW
Suggested Edits Not available1
MDX Components NEW
Reusable Content
rdme@10 NEWRequires upgrade from rdme@9 and earlier
API Designer
(Manual API Definition)
$refs and reusable object definitions are not supported
APIv2 NEWRequires upgrade from APIv1
OpenAPI/Swagger
GraphQL
LLMs & Ask AI NEW
Owlbot AI
AWS Gateway Integration Not available1
Localize IntegrationThis may require an update to your translations after migrating

Enterprise Customers

LegacyRefactoredAdditional information
Global Reusable Content
Global Custom Components NEW
StagingCheck out our new Branching feature instead
Branching: Reviews NEWComing soon!
Review and compare your branch to production before merging
Translations Not available1

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.