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

Syncing Versions from GitHub

Users on Refactored can now sync versions from GitHub to ReadMe! Once you connect to a GitHub repo, semver versions you push to GitHub will appear in ReadMe.

New Features & Improvements

  • Enterprise: Audit logs now include changes made via Git, and have a new look with improved information density, sticky headers and moreβ€”along with several bug fixes.
  • Accessibility: Improved labels for navigation landmarks along with several aria-label improvements.
  • Settings:
    • Added an option to toggle Table of Contents in Guides and Reference pages with only Markdown. Refactored
    • Added an option to customize the What’s Next label. Refactored

πŸ› Bugs Eaten (by Owlbert)

  • Personalized Docs: Fixed an issue where the example for custom variables was not visible.
  • API Reference:
    • Fixed an issue where the parameter value type UI would have misaligned text.
    • Fixed an issue with OAuth 2.0 authorization support. Refactored
    • Fixed an issue where example values were not populating enum inputs.
    • Fixed an issue where strings with uuid format were not being surfaced.
  • Docs:
    • Fixed an issue where projects with only one version would not be displayed with enough contrast. Refactored
    • Fixed an issue where empty states would show momentarily when loading. Refactored
    • Fixed an issue where loading states would appear for a little too long. Refactored
    • Fixed a regression with responsiveness. Refactored
  • Custom Components:
    • Fixed an issue where the Tailwind styles weren’t being set when previewing in dark mode. Refactored
    • Fixed an issue where the page would sometimes crash. Refactored
    • Many issues with editing and adding components in the editor have been fixed. Refactored
  • Changelog: Fixed a regression where the type would be shown as "NONE" when none was selected. Refactored
  • Recipes: Fixed an issue where featured Recipe content could be editable.
  • Accessibility:
    • Fixed an issue where non-required inputs were not being reported to accessibility tools.
    • Fixed an issue where heading focus states were not highlighting the correct element in Chrome.
  • Custom CSS: Fixed an issue where custom CSS with errors could cause issues rendering the admin UI. Refactored
  • API Designer: Fixed an issue where an invalid type from an OAS file would be displayed without warning. Refactored
  • Search: Fixed an issue with custom HTML code appearing in search results. Refactored
  • Custom Login: Fixed an issue where login/out URLs could not be empty. Refactored
  • Editor:
    • Fixed an issue where the navigation element to API Definitions wasn’t always visible. Refactored
    • Fixed an issue where the last page could be hard to select. Refactored
    • Fixed an issue where the deprecated banner was visible when editing. Refactored
    • Fixed an issue where users were unable to duplicate certain Reference pages. Refactored
    • Fixed an issue where the rename category input could be cut off ever so slightly. Refactored

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