Field Notes

changelog April 10 2026
 

Bug Fixes & Improvements

This release refreshes the Table of Contents with a new animated scroll-tracking design, speeds up page loads across search and Ask AI, and dramatically shrinks API Explorer payloads for large OpenAPI definitions.

Improvements

  • Docs:

    • Introduced a new animated Table of Contents that tracks your scroll position, with refined typography and spacing.
    • Added support for object header parameter serialization in the API Explorer’s “Try It” and generated code samples.
  • Performance:

    • Performance improvements for search, and Ask AI.
    • Removed OpenAPI dereferencing from the API Explorer, dramatically cutting payload sizes for large API definitions (previously 10MB+ for some customers).

Bugs Eaten by Owlbert

  • API Reference:

    • Fixed reference page crashes on OpenAPI definitions using map-style examples on parameters, and on reference pages visited directly at /reference/ with no slug.
    • Fixed API Explorer fields not auto-filling with schema defaults when navigating between endpoints that use different schema types (e.g. body vs formData).
    • Fixed discriminator defaults being pulled from the wrong subschema when a definition's mapping order differed from its oneOf order.
    • Fixed numerous $ref resolution bugs in the API Explorer, including lazy response resolution, infinite-recursion protection, and over-eager default enum injection on optional fields.
  • Docs:

    • Fixed the search trigger disappearing on projects, and fixed search not handling disabled sections when switching between projects.
    • Fixed intermittent blank page crashes in Discussions.
    • Fixed decoded URLs not being matched correctly against redirect rules.
    • Fixed duplicate scrollbars and missing #id anchors in the Table of Contents.
    • Fixed an edge case where custom code couldn't read SSR props on page load.
    • Fixed an issue where Recipe button text color was not adapting to the button’s background color for readability.
    • Global Reusable Content blocks are now properly expanded when pages are indexed for search.
  • AI Agent:

    • Fixed the AI chat input being wiped when navigating between pages, and fixed the input not being fully disabled when all models were disabled.
  • Editor:

    • Fixed the built-in Anchor component failing to deserialize back into a link in the editor.
    • Fixed the "What's Next" link editor failing silently when linking to a page whose slug had changed or been deleted — an actionable error now appears.
    • Fixed the page history diff view showing the wrong file when slugs were duplicated across sections.
  • Admin:

    • Fixed SAML group mapping not working from the dashboard.
  • Git Sync:

    • Fixed a race condition where concurrent commits on the same branch could drop files into parent directories or lose _order.yaml entries on retry.
    • Fixed missing branch records now self-healing during bi-directional sync instead of requiring manual database intervention.
    • Fixed case-sensitive branch filtering in the Git Sync UI.
  • MCP:

    • Now correctly returns guide pages for guide-scoped queries.
  • API:

    • Fixed the API incorrectly reporting hidden pages as indexable.
Customer StoryRisk Management
 
Socure

Socure partnered with ReadMe to drive higher API engagement, lower support costs, and get developers to production faster.

Our goal was a best-in-class developer experience, and ReadMe was the clear winner. Out-of-the-box features with real customer impact, collaborative editing across product teams, and bi-directional sync from the UI meant no other solution checked all the boxes the way ReadMe did.

Harish, Head of Developer Experience
Read Socure's story →
Socure Documentation