Coming Soon to Refactored

❗️

Refer to ReadMe's Docs for the latest updates!

Please note that once your team has access to this playground environment, our team will no longer be editing this project, including this page. That means these coming soon updates might be out of date.

For the latest updates, please refer to ReadMe's Feature Compatibility breakdown here: https://docs.readme.com/main/docs/migration#/feature-compatibility

Staging ➡️ Branches

If you use Staging in your current Enterprise Group, please note that the Staging experience in Refactored is not yet at 1:1 parity with the legacy ReadMe experience. The next era of Staging in ReadMe Refactored is launching in the near future, with the current ability for Enterprise Admins to create, merge, edit, and delete branches.

Soon, a branches-based workflow will replace the legacy Staging workflow, and will include new functionality including new permissions, review processes, and ways for Admins on your team to collaborate on documentation in the ReadMe UI and in GitHub.

If you're curious about Branches, feel free to experiment in this project! You can also learn more about the current functionality in our docs.

Global Blocks: Reusable Content and Custom Components

If you've created Global Reusable Content blocks in your Enterprise Group, your Group may not be an ideal candidate for migrating to Refactored (yet). We currently cannot support migrating existing Global Reusable Content blocks from your legacy Group to your new Refactored Group. However, with the new Refactored experience, Enterprise Group Admins will be able to create new Global Reusable Content blocks and new Global Custom Components.

Also, this only applies to Group-level Reusable Content blocks. Any Reusable Content blocks created at the child level will migrate over to Refactored, and child projects will also have the Custom Components feature.

Suggested Edits

If your team relies on Suggested Edits as part of your internal workflow to propose changes, this will be solved by Branches (available now) and reviews (to come).

If, however, your team allows visitors to your documentation site to propose comments and/or changes via Suggested Edits, this functionality will not be supported in Refactored when you upgrade. We are planning to build a feature that replaces the use cases and functionalities that external Suggested Edits provided, but don't have a timeline to share presently.