Keyboard shortcuts make using ReadMe easier and faster for power users. We’ve added a new set of navigation shortcuts to make ReadMe easier to use:

• ⌃1 / ⌃2: Open the View and Edit pages
• ⌃,: Open admin settings
• ⌃i/ ^b/ ^m: Toggle AI, Branches, My Developers
• alt+1 / alt+2 / alt+3 / alt+4 / alt+5: Navigate to Guides, Recipes, Reference, Changelog, and Custom Pages

---

New Features & Improvements

Admin

• Improved loading times for projects without Custom CSS/JS
• Added support for rotating JWT secrets
• Improved performance when saving pages

API Designer

• Added support for number and json types
• Added support for editing enums

API Reference

• Improved readability of API methods

MCP Server

• Added support for returning code snippets

Search

• Increased the number search results returned

Bugs Eaten (by Owlbert) 🐛

Admin

• Fixed an issue where entering invalid redirect rules would not display an error
• Improved error handling when navigating to a version or branch that doesn’t exist
• Fixed an issue with notifications failed to appear when exporting content
• Fixed an issue that could cause saving to fail when editing a page
• Fixed an issue where the editor could crash

AI Agent

• Fixed an issue where the AI Agent could fail to process requests
• Fixed an issue where diffs were not being displayed correctly

API Reference

• Fixed an issue where request code snippets did not use the correct theme in light mode

Docs

• Fixed an issue with the page not scrolling to the top when navigating
• Fixed an issue with embedding docs as an iframe
• Fixed an issue on legacy projects with viewing pages as Markdown showing mismatched content
• Fixed an issue where endpoint pages were not appearing in search results

We’ve added new options for branch management: you can now delete a branch after it has been merged and merge a branch directly from the editor UI.

---

New Features & Improvements

Recipes

• Improved layout and styling on the list of Recipes page.

API Designer

• Added an option for users to disable Try It Now and our API Proxy in the API Designer.
• Deleting an endpoint from the API Designer will now also remove it from the OpenAPI file.

AI Agent

• The AI Agent will now output JSX by default.
• When a page has MDX errors, you will be able to automatically fix them using the AI Agent.

Bugs Eaten (by Owlbert) 🐛

Documentation

• What’s Next links for pages in the Reference section containing only markdown will now go to the correct place.
• Fixed an issue with viewing API Reference pages as Markdown.
• Fixed an issue where navigating between multiple sections could result in users seeing an empty state instead of previously loaded content.

Search

• Fixed an issue searching on versions that aren’t the main version of the project.

OpenAPI Import

• Fixed an issue where validation issues in an imported OpenAPI file weren’t being surfaced properly.

Recipes

• Fixed an issue with syntax highlighting in Recipes.

Editor Role

• Fixed an issue where users with the new Editor role weren’t able to access disabled sections.
• Users with the Editor role will now also be able to edit content stored in the Enterprise group.

Email Notifications

• Added a confirmation page for unsubscribing from emails to prevent email clients that prefetch links from inadvertently unsubscribing.

Owlbot

• Fixed an issue with Owlbot not returning responses in legacy projects.
• Slightly improved the average quality of Owlbot responses.

API Designer

• Fixed an issue with editing endpoints in OAS files where the filename contained spaces.
• Fixed an issue with editing the path/method for endpoints without an explicitly defined operationId.
• Fixed an issue where removing the last required item from an object resulted in an invalid OpenAPI file.

We’ve added a new Editor role available for all Enterprise customers. Editors can edit content, but won’t have access to any project settings. Users can also decide if editors will have limited access to merging.

---

New Features & Improvements

AI Agent

• Rewrote the AI Agent for a significant improvement in reliability

API Designer

• Request body schemas on endpoints with non-POST/PUT/PATCH methods are now editable
• Users can now add and edit XML response examples

API Reference

• Long parameter names in the API schema will wrap instead of truncating so users can see the entire name without hovering

Branches

• Added a link to view the branch in GitHub
• Added an option to delete branches after merging

Enterprise

• Enterprise customers migrating to Refactored will be able to see their migration status on the Enterprise Dashboard

Performance

• Improvements to response times when navigating between pages

Bugs Eaten (by Owlbert) 🐛

API Designer

• Fixed an issue where updating endpoints would not be reflected in the sidebar until a save

API Reference

• Fixed an issue where some OpenAPI specs would not load
• Fixed an issue on legacy projects where code snippets would show @api/undefined

Ask AI (for LLMs)

• Fixed an issue where View as Markdown wasn’t working for endpoint pages that weren’t connected to an API definition

Changelog

• Fixed accessibility issues with repeating <main /> elements, ids and h1s

Docs

• Fixed an issue with inconsistent spacing on Custom Pages, Discussions, and the Changelog
• Fixed an issue when navigating to a page with a hash beginning with a number
• Fixed an issue where search would not filter to the current version of the docs by default

Editor

• Fixed an issue where hovering over an image would cause the page to think the editor was in a dirty state
• Fixed an issue when navigating to pages with a hash would not scroll to the target id
• Fixed an issue where having non-endpoint reference pages in What’s Next links would prevent page saves

My Developers

• Fixed an issue with testing webhook configurations

Recipes

• Fixed an issue where Recipe actions were not focusable when editing

Suggested Edits

• Fixed an issue where Suggested Edits would not populate in the admin UI

New Features & Improvements

• AI: Added the ability to clear chat with AI Agent Refactored
• Editor: Improved the rendering of mermaid code snippets to differentiate them from code that is displayed

Bugs Eaten (by Owlbert) 🐛

• AI: Fixed the displayed MCP configuration URL for Enterprise projects Refactored
• Branching: Fixed styling for the save changes to branch button Refactored
• UI:
  • Fixed spacing in header UI on mobile
  • Fixed hiding the user controls in the new Compact theme Refactored
  • Fixed an issue with admin controls in refactored sporadically not rendering Refactored
  • Improved the Search modal to better distinguish search results from page content
  • Fixed an issue where linking to a heading in view mode would scroll back to the top of the page Refactored
• SEO: Fixed an issue where pages would have duplicate SEO meta tags
• Editor: Fixed an issue with saving image configuration in the editor

---

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

---

New Features & Improvements

Admin

• You can now close Settings, Branches, and the AI menus by pressing esc Refactored
• Added page views in Documentation Metrics for .md endpoints
• Improved semver validation for versions

API V2

• New endpoints for making changes to Recipes Refactored
• New endpoints for uploading images (including your logos) Refactored
• Improved handling of large OAS uploads Refactored
• Improved consistency when getting project URIs from content responses Refactored

Branches

• Users can now create a branch from changes made in a versionRefactored

Editor

• Improved delete and enter behavior in editor. If the cursor is before a code, html, mdx, or table it will no longer delete the block. enter can now be used to leave focus when editing certain blocks
• Improved UI for setting code block syntax and tab names
• Improved highlight colors for dark mode
• Custom Pages can be swapped between Markdown and HTML while preserving existing content
• Added enter hotkey to open Reusable Content when it has focus

Performance

• Reduced the amount of JS loaded on pages
• Improved how we fetch sidebar, files, API definitions, components, and reusable component data

Bugs Eaten (by Owlbert) 🐛

Admin

• Fixed an issue where the Search placeholder would be tiny in Safari Refactored

API Reference

• Fixed an issue where example tabs with long names could overlap improperly
• Fixed an issue where users couldn‘t edit API definitions if the definition container server variables Refactored

Branches

• Fixed an issue where users couldn’t view OAS files from a branch Refactored
• Fixed an issue where users could create merge conflicts that Git can’t safely merge. Users will now be warned before continuing those merges Refactored

Docs

• Fixed an issue where empty categories were publicly visible
• Fixed an issue where the incorrect logo would be shown until dark/light mode is toggled

Editor

• Fixed an issue where image max-width wasn’t updating onBlur
• Fixed an issue where especially large pages could not be edited
• Fixed an issue where paragraphs could be added by pressing the up arrow at the top of a page

Enterprise

• Fixed an issue where Enterprise customers could not update their OAuth apps

Recipes

• Fixed an issue where direct links to a Recipe were not working Refactored

---

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

We've added the ability to export documentation for projects on ReadMe Refactored. All sites can be exported as a ZIP folder containing all the project's content. Additionally projects on our Business and Enterprise can be exported as a PDF containing the markdown content.

We’ve also added support for Branches (beta) for Business plans in ReadMe Refactored! Learn more and share feedback at [email protected].

---

New Features & Improvements

Enterprise

• Added the option to configure TLS and HSTS settings in the Enterprise Dashboard

Settings

• Added support for saving settings pages via a keyboard shortcut Refactored

Editor

• Added a button to copy the link to a specific heading directly from the editor
• Added the option to open links in a new tab

API

• Added new public API endpoints for interacting with Branches and Versions Refactored

Bugs Eaten (by Owlbert) 🐛

Performance

• Improved frontend performance for projects not using Custom JavaScript Refactored

Appearance

• Fixed an issue preventing updates to the color of the line in the Line header theme Refactored

Editor

• Fixed an issue where saving a page in the Raw Mode editor resulted in a broken state Refactored
• Fixed an issue where Reusable Content containing a Variable would crash the page in non-refactored Projects
• Fixed an issue navigating the editor menu with arrow keys

Changelog

• Fixed an issue where Changelogs beginning with a link would crash the page Refactored

---

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

We’ve added support for Ask AI on the API Reference pages, an option to ask Copilot, and it now remembers your last used option.

---

New Features & Improvements

Performance

• Search indexing was improved for better performance.
• Refactored how we generate metadata to improve time to first byte performance. Refactored
• Significant reductions to our initial bundle sizes (at least 25%).
• Immutable assets will be cached for longer.

API Reference

• Added support for arrays of objects in API Designer. Refactored
• Added an option to make the /openapi path public. Refactored
• Reordering endpoints and pages will now persist after resyncing.

Admin

• Added an option to hide icons used in the header. Refactored
• Added an option to export content. Refactored

---

Bugs Eaten (by Owlbert) 🐛

Admin

• Fixed an issue where logging out from Settings was not working. Refactored
• Fixed an issue where Business plan customers were unable to edit footers. Refactored
• Fixed an issue where the current active state for navigation didn’t persist when switching between edit and view modes—while using the tab navigation. Refactored

Versions

• Fixed an issue where starting a version with an extra v could cause issues. Refactored
• Fixed an issue where very long version names could break the create version UI. Refactored

API Reference

• Fixed an issue where Getting Started, Authentication, and My Requests pages could appear out of order.
• Fixed an issue with rendering some API Reference pages.
• Fixed an issue where x-readme-id was being saved to OAS files when using the API Designer. Refactored
• Fixed an issue where the delete parameter dropdown would stick around longer than it should. Refactored
• Fixed an issue where the request examples menu overflow was not triggering scroll.

Editor

• Fixed an issue with creating links to API Reference.
• Fixed an issue where changing the page slug would result in an error—even though the change was saved successfully.
• Fixed an issue with Recipe Tiles not working in Reusable Content.
• Fixed an issue where Components was not accessible to Startup plans. Refactored
• Fixed an issue where the page could crash when clicking on a Glossary term.
• Fixed an issue where emojis that are the first character in a title would appear saturated in the editor in Chrome. Refactored
• Fixed an issue where an empty table cell could crash the page.
• Fixed an issue where pages with MDX errors could trigger a 404 error. Refactored
• Changed when max-width on image size is set to prevent inadvertently sizing them at 1px.
• Fixed an issue where you couldn’t edit Reusable Content after there’s been a rendering error.
• Components will now proactively display an error when creating an incorrectly named component. Refactored

Recipes

• Fixed an issue where users couldn’t save Recipes without an emoji avatar.

Enterprise

• Fixed an issue where switching versions on child projects would navigate you to the landing page instead of the same page on the switched version.

Documentation

• Fixed an issue where pages could scroll horizontally. Refactored
• Fixed an issue where the Thumbs Down vote was not working.

---

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

We’ve added a few new features to allow your docs to be discovered and integrated with AI tools.

• We’ve added support for llms.txt so documentation can be read and understood by LLMs. You can see an example on our project at https://docs.readme.com/main/llms.txt. This is enabled via a new setting in the AI dropdown on Refactored projects.
• Every page can also be accessed in plaintext markdown by adding .md to the end of the URL. For example, you can do that on this Changelog post: https://docs.readme.com/main/changelog/ask-ai-llms-txt.md.
• We’ve also added a new setting to enable an “Ask AI” button on your documentation pages. This will let a user ask their favorite AI tool questions about the contents of any page.

New Features & Improvements

• Reusable Content: Added support for saving Reusable Content and Custom Components with the cmd/ctrl+s keyboard shortcut
• Sidebar: Improved spacing and UI of the sidebar while also adding new CSS variables to allow for easier customization Refactored
• Styling:
  • Added a new look for the Line navigation theme. Existing projects will have an option to upgrade to the new design in the Appearance section Refactored
  • Allowed users to collapse the sidebar in the documentation Refactored
  • Redesigned admin UI navigation for Refactored to consolidate settings Refactored
  • Added filter in the new settings UI to make them easier to locate Refactored
• API:
  • Added new API endpoints for creating, editing, and deleting Categories Refactored
  • Added new API endpoints for editing and deleting Changelog posts Refactored

🐛 Bugs Eaten (by Owlbert)

• Editor:
  • Fixed an issue with characters being escaped unnecessarily on save
  • Fixed a crash when a JSX element was placed within a markdown list
  • Fixed a crash when typing www.
  • Fixed inserting links to the Reference section via the linking UI Refactored
  • Fixed the toolbar not always appearing when text is highlighted
• MDX: Improved error messages when saving invalid MDX Refactored
• API Reference:
  • Improved performance syncing OpenAPI files with large amounts of circular references
  • Fixed an issue where OpenAPI files with symbols in the filename weren’t being encoded correctly and causing errors Refactored
  • Fixed an issue where viewing a non-endpoint page in the Reference section would show the wrong section in the navigation
• Styling:
  • Fixed an issue where long unbroken code samples would cause the documentation site to have a horizontal scrollbar Refactored
  • Fixed flashing of the sidebar when the page history panel is also open Refactored
• Recipes:
  • Fixed an issue where saving a Recipe with a code sample without any content would result in a 500 error Refactored
  • Fixed an issue preventing Recipes from rendering properly when embedded in a Documentation page Refactored
• Styling:
  • Improved the styling of our dark mode syntax highlighting theme Refactored
  • Fixed horizontal scrolling on the My Requests page on smaller screen sizes
• My Requests:
  • Fixed the link for “See All Requests” for enterprise projects
  • Fixed an issue making the My Requests page public Refactored
• Search:
  • Fixed an issue where search was returning no results on specific Enterprise projects Refactored
  • Fixed an issue where some page content wasn’t being indexed for search properly
• Discussions: Fixed the link in the notification email when a new discussion post is submitted

---

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

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.

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.