We’ve added a new style for method badges and a convenient Preview Mode. You can now toggle Preview Mode with Ctrl + . to instantly view your docs exactly as a user would. To update your method badge look, head to Settings → API Reference → Method Badge Style.

---

New Features & Improvements

Admin

• Rolled out a new UI for Manage Team and Manage Plan.

API Designer

• Users can now edit request body examples and custom code samples.

Branches

• Added the option to mark branches as "Ready for Review."

Docs

• Added a new option to hide method badges entirely.
• Added IDs to endpoint parameters, allowing users to link directly to specific parameters.

Git Sync

• Added support for syncing force pushes.
• Improved error messages when encountering installation issues.

MCP Server

• Added support for private projects.

Bugs Eaten (by Owlbert) 🐛

Admin

• Fixed an issue where certain modals could block the admin UI.
• Fixed a crash that could occur on the dashboard for Enterprise projects.
• Resolved UI glitches regarding duplicate scrollbars and broken links on the Recipes page.

AI Linter

• Fixed an issue where the AI Linter could incorrectly report a check as out-of-date.

Ask AI Dropdown

• Fixed an issue where links to third-party LLMs in the Ask AI dropdown weren’t working.
• Fixed a bug where HTML comments were appearing in Markdown content.

API Designer

• Fixed a bug where removing custom code samples would not update the UI.
• Fixed a display issue with long code examples.

Editor

• Fixed an issue where highlighting to delete a section wasn’t working as expected.
• Fixed a bug where users couldn’t leave the history view when editing Changelog pages.
• Resolved multiple issues with editing lists and JSX inside table cells.
• Fixed an issue where Custom Pages were not validating MDX.
• Fixed an issue where the sidebar could be out of sync
• Fixed an issue where headings in Components and Reusable Content were missing from the Table of Contents.
• Fixed a bug where modifying Reusable Content would strip whitespace from its name.

Docs

• Fixed an issue where stale response examples appeared when navigating to new endpoint pages.
• Resolved multiple issues where search was not accessible on mobile, didn't filter correctly by version on Enterprise, or didn't take up the full screen.
• Fixed an issue where Cmd + K (open search) wouldn’t work when Ask AI was enabled.
• Fixed an issue where navigating to anchor links would sometimes fail.
• Fixed an issue where the Table of Contents would not stick on scroll in some projects.
• Fixed a bug where the wrong version could be displayed.

Docs Audit

• Fixed an issue where scores were not showing the correct decimal precision.

MCP Server

• Fixed an issue where search and fetch tools weren’t showing up for projects with custom domains.

New Features & Improvements

API Designer

• Added the ability to autogenerate Response Schema from an Example Response.

Bidirectional Sync

• Allowed users to remove their Bidirectional sync connection entirely.

Bugs Eaten (by Owlbert) 🐛

Search

• Fixed an issue where the wrong phrase was sometimes highlighted in search results.
• Fixed an issue where the search API for Enterprise projects on Refactored was returning 500 errors.

MDX

• Prevented the page from being saved if it contains invalid MDX syntax.

Editor Permissions

• Fixed an issue where editors viewing the synced repository information would be switched from edit to view mode.

Docs Audit

• Fixed an issue where multiple docs audits could be accidentally started at the same time.

API Designer

• Added warnings to the API Designer for OpenAPI features that aren't currently supported.
• anyOf and oneOf objects with defaults set will properly render in the API Reference section.
• After syncing an OAS file, the URL used will be remembered for subsequent resyncs.

API Reference

• Fixed an issue with API Reference pages not being indexed by search engines by default.
• Fixed an issue where Node code samples were defaulting to fetch instead of the api module.

a11y

• Several accessibility improvements including:
  • Fixed Header search state that wasn’t visible on very dark backgrounds for the solid theme.
  • Added a missing label to the search dialog.
  • Added missing labels to discussion inputs.
  • Fixed the Jump To and Header buttons not refocusing after closing their respective modals.
  • Added missing aria-expanded props in API Reference.
  • Removed duplicate IDs from API Reference.
  • Fixed an inaccessible tooltip in API Reference auth.
  • Added aria-pressed state for the language picker.
  • Fixed missing labels on feedback buttons.
  • Fixed missing labels on close buttons on all modals.
  • All tooltips now close when pressing the escape key.

MCP

• Fixed an issue where enabling MCP for specific endpoints didn't work if the OAS file was missing operationIds.

AI Agent

• Improved loading state and streaming for AI Agent responses.

llms.txt

• Fixed an issue where the generated URL for enterprise projects was incorrect.

Sitemap.xml

• Fixed an issue where custom pages had the wrong URL in the generated sitemap.

Guides

• Fixed an issue printing pages that are more than one page long.

This week we launched several new features powered by AI to help you create and maintain great documentation more easily.

• AI Linting: Write rules and guidelines about what makes good documentation in plain English that our AI will use to give you feedback on individual docs while they are being written.
• Docs Audit: Run the AI Linter over your entire set of documentation to get an overview of which pages need the most improvement and report on the quality of your docs over time.
• Agent Owlbert: Our own AI Agent with all of the knowledge of how to use ReadMe most effectively. Use it to help you write your content as well as get assistance on ReadMe features.
• New AI Search: We've redesigned our AI Search in the documentation as a conversational interface that understands context, remembers previous questions, and can guide developers through complex implementation scenarios.

You can read more about each of these features in our full launch blog post.

---

New Features & Improvements

API Designer:

• Added support for editing and creating multiple security schemas and setting default security configurations across all endpoints.
• Added the ability to duplicate endpoint pages.

API Reference:

• Added more configuration options for who can view OpenAPI files. Previously, this was limited to only project admins or public access; now project editors and viewers can also be given access.

MCP:

• Added support for using our built-in MCP server for projects using a custom login.

Discussions:

• Added improved support for spam filtering in discussion forum comments.

Bugs Eaten (by Owlbert) 🐛

Search:

• Fixed an issue where searches with no results would sometimes return results containing the section name being filtered.

Editor:

• Fixed an issue where multiple warnings about page size would appear at the same time.
• Fixed some tables that used the pipe character within table cells.

Admin UI:

• Fixed an issue where some modals weren't properly opening in Safari.

The API Designer is now more powerful and easier to use. You can rearrange parameters with a simple drag-and-drop, while also defining more complex and accurate APIs. We've recently introduced fully editable response schemas; added support for advanced structures like arrays, objects in query parameters, and json types; and improved how we render enums.

---

New Features & Improvements

Admin

• Added a new keyboard shortcut (Ctrl + J) to open the admin navigation menu

Docs

• Open Graph images now use your project’s color scheme
• Improved the heading and section hierarchy in API References for better readability

MCP

• Added support for custom tools to be used in your MCP server

Owlbot AI

• Improved indexing reliability for more accurate and timely results
• Increased context limits by 400% to better support larger documentation sets

Bugs Eaten (by Owlbert) 🐛

Admin

• Fixed an issue with relative links not working correctly
• Fixed a bug that occurred when navigating to the Recipes page and switching to edit mode
• Fixed an issue with editing endpoint pages after deleting their definition
• Resolved an issue where owners of Enterprise projects with staging enabled were not receiving emails when end users requested access
• Fixed an issue with changing header styles for some enterprise customers
• Fixed a bug where switching to the "Edit" tab would incorrectly reset page navigation
• Fixed an issue where notifications were not appearing in view mode

AI Agent

• Fixed a bug with the Agent sometimes showing an incorrect diff
• Fixed an issue where the chat input would not display the full content
• Fixed an issue with the Agent failing to edit empty pages

Branches

• Fixed an issue where merging branches could cause a white screen

Docs

• Fixed issues with navigating to custom pages and to specific headings within a page
• Fixed display issues with enums in API References
• Fixed an issue where duplicate boolean values could appear in parameters
• Fixed an issue where date parameters could have slightly different formats
• Fixed an issue where example.com would be displayed when specs were invalid
• Fixed an issue with the response UI handling a large number of examples
• Fixed an issue where custom footers on Recipe pages were not displaying properly

Editor

• Fixed an issue with the Raw Markdown toggle not working as intended
• Fixed an issue with the Make Reusable and Copy actions
• Fixed an issue where notifications could block editor actions
• Fixed an issue with inline links in table cells
• Fixed an issue where the editor would lose focus after saving
• Changing the slug of an endpoint page will no longer show an error message on success

MCP

• Fixed a compatibility issue with MCP inspector tools

Search

• Fixed search issues within password-protected and specific Enterprise project configurations

We’ve added a new Component Marketplace where you can browse and install vetted components from ReadMe and our community. You can find the marketplace on the Custom Components page and contribute to new components on GitHub.

---

New Features & Improvements

AI Agent

• You can now choose between AI models from Gemini, Claude, and OpenAI
• Added the option to provide the Agent with custom knowledge
• The Agent now has more context about your docs, leading to more relevant answers
• Chat history is now maintained per page

API Designer

• Response schemas are now fully editable
• Added support for object and array of object types in query parameters
• Server URLs are now rendered in monospace font
• Added support for editing multiple request bodies

Docs

• Enum values are now displayed in parameter descriptions

MCP

• Users can now specify which routes are enabled for their MCP server

My Developers

• Enterprise projects can now set variables without needing configured webhooks

SEO

• Open Graph images are now generated based on doc’s appearance and content

Suggest in GitHub

• Docs syncing with public repos can now add a “Suggest in GitHub” link to their pages, making it easier for readers to contribute

Bugs Eaten (by Owlbert) 🐛

Admin

• Fixed a scroll-to-target issue when navigating between pages in admin view mode
• Fixed an issue where Ask AI links would fail to load for admins
• Fixed an issue where the versions panel could render off-screen
• Fixed an issue where admins could not meta + click links to open them in a new tab
• Fixed several issues that caused the UI to unexpectedly reload when navigating

AI

• Fixed various minor UI issues in the AI settings
• Fixed a bug that prevented the AI Agent chat from being accessible

API Designer

• Fixed an issue where stale values would sometimes be displayed in the UI

CLI

• Fixed an issue where working with semver-named branches could fail

Components

• Fixed an issue where component previews could fail to render

Discussions

• Fixed an issue where some users could appear as undefined
• Fixed an issue that caused certain users to see an empty Discussions page

Docs

• Fixed an issue in Custom Login setups that failed to redirect users to the correct page after logging in
• Fixed an issue where the OAuth authentication UI would not render
• Fixed an issue that caused some redirects to fail
• Fixed an issue where projects with Custom HTML would briefly see an empty state when navigating

Editor

• Fixed an issue with pasting text into table cells
• Fixed an issue with the link component’s open-in-a-new-tab feature not working

Search

• Fixed an issue where search results were ranked improperly

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.