ReadMe Refactored Snapshot
Overview
We're excited to introduce our new editing experience that brings powerful features including bi-directional Git syncing, branching, MDX support, and a streamlined editing interface. This page provides a high level overview on everything that's new.
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.
Create and edit your docs with a new design that brings your content and appearance changes closer to what your users see.
Enhance your docs with interactive components by combining the simplicity of Markdown with the power of JSX.
Write documentation wherever works best for you, seamlessly syncing between ReadMe and your Git repositories.
Expand your workflow in ReadMe! With Branching, Admins can make changes and review them in a preview environment before they’re live.
See It In Action
Watch the video to get a firsthand look at how the new features work and feel!
Feature CompatibilityWe're continuing to release new features for Refactored as we work toward full feature parity, and keep our docs 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!
For the most recent list, refer to this breakdown in our docs: https://docs.readme.com/main/docs/migration#/feature-compatibility
Enterprise Users
Important Note for Enterprise CustomersThe new ReadMe experience has begun rolling out to Enterprise customers! If you have access to playground project like this, it means your Enterprise Group is ready—or very close—to migrating. 🎉
The ReadMe team is here to help you manage every step of the upgrade process, including the migration process itself. Now that you have access to this playground environment, your CSM will be in touch to discuss next steps, including setting a migration date for your team.
New and Improved Enterprise Features
You'll have access to all standard features mentioned above plus:
- Global Custom Components, in addition to Custom Components in your child projects
- Advanced branching features including review and approval processes—an upgrade to Staging! (Coming soon)
- Bi-Directional Syncing compatibility with your Enterprise team's own hosted GitHub Enterprise Server (GHES), if applicable
- Enhanced team collaboration tools
- Comprehensive audit logging
- Enterprise-grade security features
What's Missing
If you're currently using any features listed below, your Enterprise Group is not quite ready to migrate. While we're working to build these feature, your CSM can explain what the timeline looks like, and potential workarounds.
- AWS Gateway Plugin
- Suggested Edits - branches replaces the previous Suggested Edits internal workflow of allowing team members to leave edits and comments; we are working to build a solution in Refactored that allows visitors to propose changes!
Additional change.
Updated 10 months ago