What's New with ReadMe Refactored
ReadMe Refactored represents the future of ReadMe, and includes improvements to almost every aspect of the product, plus powerful collaboration and AI features that are exclusive to this new experience!
Built In AI Features to Empower Your Team and End Devs!
Whether you’d like help writing your docs, help your developers understand your API faster, or get useful suggestions about how to improve your docs, it’s all possible in ReadMe with our enhanced AI tools, including our built-in linter, docs audit, writing assistant, and more.
New Editing UI
All docs editing now happens on your live hub, allowing you to make edits directly in your docs and easily preview content and appearance changes before they go live.
Global Custom MDX Components
Add dynamic and interactive content like live code samples and data visualizations to your docs thanks to MDX! Choose from pre-built components, explore our GitHub marketplace, or build your own custom components using a combination of React, JSX, and Tailwind styling and easily reuse them throughout your different child projects.
Bi-Directional Syncing with GitHub
Now different members of your team can work wherever they’re most comfortable— whether in their local dev environment or directly in ReadMe’s editor— and changes will sync seamlessly between both, no manual updates necessary. As an Enterprise customer, you can also enable a GitHub Enterprise Server for your Group, in addition to GitHub Enterprise Cloud.
Branches, Reviews, and Editor Role
Now you can create branches in your docs, just like in your code. Branches allow your team to make changes and review them in a preview environment, plus send changes to teammates for review. No more one-size-fits-all staging—create as many branches as you need and merge only what’s ready.
With Branch Reviews, you're able to compare changes between the branched version and your main version before you merge. Branch Reviews provide a simple, structured way to see exactly what's changed on a branch, review in context, and approve edits before they go live.
Branches and Reviews are available on Business and Enterprise plans only.
Upgrading to Refactored
You can find more details about the upgrade process in this upgrade guide, along with some common Upgrade FAQs here. As always, if you have any questions, reach out to [email protected]!