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

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

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

Projects using ReadMe Refactored can now build their own custom components with MDX and easily style them with Tailwind. These components can be used anywhere in the documentation and can be used for all kinds of interactive widgets. We have a GitHub repository with example components that you can use in your docs or as a start for your own. We’re super excited to see what you build! 🧩 Building Custom MDX Components

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

New Features & Improvements

• Versions: Added a new version creation flow to the Refactored interface Refactored
• API: Added an API endpoint for projects on Refactored to delete a synced OpenAPI file Refactored
• GitHub Sync: Improved UX for initially syncing a repo when setting up GitHub Sync
• Accessibility: Added aria-labels to the sidebar and navigation

🐛 Bugs Eaten (by Owlbert)

• API Reference: Fixed issues with data not loading correctly when navigatign around the reference section Refactored
• API Reference: Fixed an issue where code samples using our api module weren’t being generated correctly Refactored
• API Reference: Fixed an issue preventing Windows users from being able to upload YAML OpenAPI Specs Refactored
• Changelog: Fixed an issue where saving changelog posts sometimes returned an error message even for successful saves Refactored
• Changelog: Fixed spacing for the author byline Refactored
• Versions: Better error messages when attempting to create a version with an invalid name Refactored
• Custom Footer: Fixed an issue updating the custom footer Refactored
• Documentation: Fixed an issue where the page would crash when navigating between sections containing specific types of content Refactored
• Editor: Fixed an issue with copying content with newlines in tables cells
• Enterprise: Fixed styling issues on the Enterprise list of projects page
• Custom Pages: Fixed code blocks on custom pages not updating to dark mode properly Refactored
• API Designer: Fixed an issue where pages were marked as having unsaved changes erroneously
• Recipes: Fixed an issue where on page load the code snippet would overlap with the line numbers
• Sitemap: Fixed an issue where the sitemap sometimes has stale content Refactored

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

New Features & Improvements

• Personalized Docs: Ability to test Webhook configuration for personalized docs Refactored
• API Designer: Improved clarity on how to add a path parameter Refactored
• Recipes: Recipes will now be included when cloning a project
• Documentation: Surface both Guides and API Reference pages when adding a page to the “What’s Next” section Refactored
• API Reference: Improved OAuth support in the API Reference section when scopes aren’t defined

🐛 Bugs Eaten (by Owlbert)

• Editor: Fixed an issue where HTML inside of a table cell was rendering incorrectly
• Documentation: Fixed links in pages resulting in a redirect getting caught in an infinite loop
• API Designer: Fixed an issue where editing the request body sometimes broke other parameters Refactored
• API Designer: Fixed an issue where projects using {version} in the legacy manual API editor had an error during the migration to Refactored Refactored
• Search: Fixed an issue where specific search terms could cause the page to crash Refactored
• Search: Improved search response times Refactored
• Owlbot: Fixed an issue where pages nested three levels weren’t indexed by Owlbot
• Developer Dashboard: Fixed the styling of the warning about hitting the monthly limit in Developer Dashboard Refactored

When looking at data in My Developers for a specific endpoint, it can be helpful to view the documentation for that endpoint to provide additional context. In ReadMe Refactored we now have a way to collapse the My Developers panel, showing the data and the documentation side by side.

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

New Features & Improvements

• Admin Panel: Add help button to more easily contact our support team Refactored
• Changelog: Highlight Changelog pages containing invalid MDX Refactored
• API Reference: OAS files that are YAML can now be synced for Refactored projects Refactored

🐛 Bugs Eaten (by Owlbert)

• Search: Removed unnecessary API calls during search Refactored
• Recipes: Fixed recipe embeds in the Guides section Refactored
• Recipes: Fixed directly linking to a specific Recipe Refactored
• Sidebar: Fixed an issue preventing pages from being moved between levels of nesting Refactored
• Reusable Content: Fixed an issue where reuseable content wasn’t being rendered in the reference section
• Editor: Fixed an issue where we were showing incorrect validation errors Refactored
• Editor: Fixed an issue where content inside of Style tags was getting parsed as Markdown
• Sidebar: Fixed an issue where collapsing or expanding a section in the sidebar would lose scroll position
• Editor: Fixed padding around Glossary items in the editor
• Sidebar: Improve performance of long sidebar pages Refactored
• Sidebar: Fixed hidden pages incorrectly showing up when nested at the max level Refactored
• Editor: Fixed an issue inserting HTML into table cells in Markdown
• API Designer: Disabling the API Designer will correctly disable editing the server URL and security schemes Refactored

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

You can now bookmark projects. They'll stay pinned to the top of your project list page for as long as you'd like. :)

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

New Features & Improvements

• My Developers: My Developers will now automatically filter to the currently viewed endpoint page Refactored
• My Requests: Added a filter to the API keys menu
• API Reference: Improved OpenAPI definition upload performance Refactored
• Git Connection: It now takes one less click to sync a repository Refactored
• Owlbot AI: Improved Owlbot’s ability to answer questions about APIs with large API definitions

🐛 Bugs Eaten (by Owlbert)

• My Developers: Fixed an issue where not all docs content would be accessible in split view mode Refactored
• My Developers: Fixed an issue with Try It requests not showing request body data Refactored
• My Requests: Fixed an issue where the page would crash
• Docs: Fixed an issue with iframes not rendering
• Docs: Fixed an issue where pages could crash if navigation data was in a bad state
• Docs: Fixed an issue with the previous page link skipping over endpoint pages with no Markdown content
• Docs: Fixed an issue with SSR Refactored
• Editor: Fixed an issue with the inline editor in Safari not working
• Editor: Fixed an issue where some Reusable Content blocks would cause the page to crash
• Editor: Fixed an issue where titles in new components like <Accordion /> were not being indexed Refactored
• Editor: Fixed an issue where Reusable Content would be loaded as plain jsx nodes Refactored
• ReadMe API: Fixed an issue where pages nested 2 levels deep could be orphaned when moving them
• Developer Dashboard: Fixed an issue where the setup state would show as complete, when it was in fact not complete
• API Metrics: Fixed an issue where tooltips in graphs could render outside the viewport
• Landing Page: Fixed an issue with landing pages not loading Refactored
• Admin Dashboard: Fixed an issue with navigating to child projects
• Discussions: Fixed an issue where creating empty posts could cause the page to crash
• Owlbot AI: Fixed an issue with URLs generated by Owlbot
• API Reference: Fixed an issue where selecting a response example would not automatically close the example menu
• API Reference: Fixed an issue where webhook pages could be skipped in the project navigation
• API Reference: Fixed an issue with rendering parameters if certain OAS extensions were used Refactored
• Custom Login: Fixed an issue with custom login display

All of our Owlbot customers will now be able to configure a Copilot extension that interacts with their documentation. By setting up your own Copilot extension, your users will be able to install it directly in their IDE so they can ask questions right where they are working.

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

New Features & Improvements

• Custom Variables: Add a link to setting custom variables in Personalized Docs Refactored
• MDX: Improved the editing experience for mdx in the editor Refactored
• Documentation: Improved clearing cache after updating content resulting in changes showing up much quicker to end users Refactored
• Accessibility: Accessibility fixes to search, what’s next, and landing page
• Accessibility: Accessibility fixes to the Getting Started, Authentication, and My Request pages
• Auth: New users verifying their emails for the SAML login flow will be properly redirected back to the original page
• Personalized Docs: Add support for setting up Personalized Docs with AWS
• Documentation Metrics: Added link to Documentation Metrics in Refactored projects Refactored
• MDX: UI improvements to how we surface pages with MDX error in Refactored projects Refactored

🐛 Bugs Eaten (by Owlbert)

• API Reference: Properly support nullable: false in the Reference section
• Recipes: Fixed for recipes containing specific markdown characters Refactored
• API Reference: Fixed an error when uploading OAS failed due to a missing category error Refactored
• Realtime: Fixed issue where our generated Getting Started & Authentication pages appeared in incorrect places in the sidebar Refactored
• SEO: Fixed issue where nested pages weren’t appearing in the sitemap
• Documentation/Editor: Fixed scroll position being incorrect when switching between View and Edit mode on some pages Refactored
• Versions: Fixed renaming versions on Refactored projects Refactored
• Documentation: Fixed issue where pages with long slugs would 404 in Refactored projects Refactored
• Suggested Edits: Fixed issue where pages with a missing excerpt were unable to have suggested edits
• Security: XSRF cookies should now have the secure attribute
• Owlbot: Fixed UI issues when question wrapped to multiple lines

Over the past year, we’ve been reimagining, reinventing and refactoring every single part of ReadMe. And now, it’s here! New updates include a new editing UI, MDX components, syncing with GitHub, My Developers, and more. Read our blog and docs for more details.

New Editing UI

Sync with GitHub

It’s now easier to see changes as you make them with Site Navigation, Appearance, Custom CSS, and more appearing as you edit. And now you can sync content changes, including Guides, OAS files, References, Recipes, and Custom Pages with GitHub.

MDX & New Editor Blocks

We've added support for MDX and new editor components, including columns, tabs, accordions, and Mermaid. Read the docs

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

New Features & Improvements

• My Developers: The new My Developers helps you learn how developers interact with your API and reach out to them if they get stuck. Refactored
• Page History: Changes in page history now show the difference between each change, instead of comparing to what’s live Refactored

🐛 Bugs Eaten (by Owlbert)

• Developer Dashboard: Fixed an issue with our webhook testing flow
• Developer Dashboard: Fixed an issue with fresh data not appearing right away after setting up
• Custom HTML: Fixed an issue where footer HTML wasn’t appearing in all pages
• Editor: Fixed an issue with performance when working with a large amount of pages
• Accessibility: Fixed various accessibility issues with missing labels and color contrast
• Admin Menu: Fixed an issue with icon consistency