Log InSign Up

Field Notes

changelog May 9 2025
 
View all changelogs

Ask AI & llms.txt

Ask AI & llms.txt

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.

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

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 Eatten 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

  • 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

Older Posts

Ready for a developer hub developers love?

Sign up for a free 14 day trial of the full platform. Your API Reference is free forever.

Get Started
or
s
200
200
200
Owlejandro celebrating
Owlbert celebrating
Owlivia celebrating
confetti
confetti