Welcome to your ReadMe Refactored playground!

The ReadMe Refactored experience represents the future of ReadMe, and includes upgrades to almost every aspect of the product. We're so excited for you to start exploring this new experience, and hopefully making the decision to upgrade your production environment to Refactored soon. ✨

🔍 Explore Refactored

On the following Guides pages you'll find overviews on Refactored's core new features, including the Editing UI, our MDX-powered editor and Custom Components functionality, Bi-Directional Sync with GitHub, and Branches.

✍️ A Refactored Playground

This project is entirely yours to explore, add to, and experiment with! While the Guides pages are designed to be informational, they're also fully editable! Additionally, the API Reference section is intentionally left open so that you can try adding an API definition in ReadMe or via GitHub.

Play Around with New Features: This is a great opportunity to get comfortable with the new Editing UI! Make updates in Edit mode, and toggle to View mode to see how they render. Try adding any of our 5 pre-built MDX components or create your own, either in this child project or at the Enterprise Group level.
Set Up a Test API Reference: Add an API definition via file or upload from the Editing UI, or use our API Designer (the updated Manual Editor!) to create or edit an API definition. You can also connect your ReadMe project with GitHub via bi-directional sync and sync your API definition that way!
Sync Bidirectionally One of the biggest updates to ReadMe Refactored is Bi-Directional Sync with GitHub, which allows you to make updates to your docs in ReadMe, GitHub, or both, and changes will always be synced bidirectionally. To get started, head to the Git Connection page in the Settings menu of your Editing UI.
Collaborate via Branches Now you and your team can make changes to this project without impacting each other's work thanks to Branches! Create a branch off this project's main version or another version that you create, and try creating, editing, merging, and deleting branches.

💬 We're Here to Help!

While you're exploring, you can always feel free to reach out to your CSM, Solutions Architect, or our Support team via [email protected] if you have any questions or suggestions.

We're excited you're here! 💙

🎉 Ready to Migrate Your Production Environment?

Once you're ready to migrate your ReadMe Enterprise Group(s) and corresponding child project(s) to ReadMe Refactored, reach out to your CSM and Solutions Architect to let them know! They'll walk you through all of the steps and schedule a date when our team will take care of the entire migration process. 🚀

This won't be fun to clean up...