These docs are for v2.0. Click to read the latest docs for v3.0.

Bug Fixes & Improvements

New Features & Improvements

  • API Designer: Allow page title and excerpt to be edited even if the API Designer is disabled Refactored
  • Changelog: Improved caching for Changelog posts to prevent seeing stale content Refactored
  • API Reference: Improved display for OAS files with polymorphism
  • MDX: Better validation when saving custom components Refactored

πŸ› Bugs Eaten (by Owlbert)

  • API Definitions: Improve performance on the list of API Definitions page for projects with many API Definitions Refactored
  • Refactored Migration: Fixed cases where customers with manually defined API Definitions were unable to be migrated to ReadMe Refactored successfully
  • Search: Search results for Changelog and Discussion posts won’t include markdown syntax in the search result Refactored
  • API Reference:
    • Fixed issue where long responses weren’t able to be scrolled
    • Fixed Webhook pages not rendering correctly Refactored
  • Sidebar: Fixed an issue where dragging pages with nested children into other pages, surpassing the supported limit Refactored
  • MDX:
    • Add support for previewing a custom MDX component in dark mode Refactored
    • Fixed a flash of unstyled content when loading a page with a custom component Refactored
    • Fixed styling of Mermaid diagrams in dark mode Refactored

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