API Designer

ReadMe’s API Designer UI

Customers who have migrated to ReadMe Refactored now have access to the new API Designer. The new API Designer is easier to use, and outputs OAS files that can automatically sync to your GitHub repo.


Refactored Some improvements are only available once your project has been upgraded.

New Features & Improvements

  • Editor: The sidebar has be rewritten with significant improvements to performance
  • Editor: Improved performance on projects with a large number of pages in the "What’s next" block and [ page selector
  • Owlbot: Improved performance when typing
  • API Reference: Added support for maxItems and minItems

🐛 Bugs Eaten (by Owlbert)

  • Editor: Fixed an issue where code blocks content would overlap with line numbers
  • Editor: Fixed an issue where users couldn’t save MDX components Refactored
  • Editor: Fixed an issue where the changelogs would sometimes crash Refactored
  • Editor: Fixed an issue where deleting the last Reusable Content could cause the page to crash Refactored
  • Editor: Fixed an issue with adding Recipes to a page Refactored
  • Docs: Fixed an issue where empty states would appear momentarily while loading Refactored
  • ReadMe Refactored: Fixed a potential display issue with the welcome modal Refactored
  • SEO: Fixed an issue in Enterprise projects where the incorrect robots.txt file was being used
  • Suggested Edits: Fixed an issue where Suggested Edits would crash on a page with Reusable Content Refactored
  • Admins: Fixed an issue where some projects were unable to be bookmarked