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

We’ve redesigned the project list page. Completely rebuilt for improved performance, information density, and with direct links to docs, settings, and your dashboard.

Improvements

• API Reference: Removed a confusing tooltip for outdated request history items
• API Reference: Deprecated icons moved to the right for visual alignment
• API Reference: Copy has been updated to replace authorization with credentials in a few places for accuracy

🐛 Bugs Eaten (by Owlbert)

• Developer Dashboard: Fixed an issue where switching API keys would not persist between pages
• Developer Dashboard: Fixed an issue where the webhooks configuration page could jump around while typing
• Developer Dashboard: Fixed an issue where webhooks URLs weren’t being validated properly
• Discussions: Fixed an issue where CAPTCHA was not displaying properly for some Enterprise projects
• Manage Plan: Fixed a typo for Recipies

Improvements

• Performance: Improved page load times for projects with lots of custom CSS/HTML/JS
• API Reference: Improved response header text wrapping
• Staging: Improved search indexing reliability

🐛 Bugs Eaten (by Owlbert)

• Staging: Fixed an issue where the page could crash in production when navigating to a page that’s been moved in staging
• API Reference: Fixed an issue where Try It could cause the page to crash with when JWT has been misconfigured
• API Reference: Fixed an issue where the response UI could not accommodate a large number of examples
• API Reference: Fixed an issue where API key selection wasn’t persisting across endpoints
• API Reference: Removed a confusing tooltip in the request history table
• API Reference: Fixed an issue where webhooks parameter headers were rendering incorrectly
• Export: Fixed an issue when exporting projects with special unicode characters not being displayed properly
• Discussions: Fixed an issue where Markdown wasn’t rendering in the Discussions list
• Reusable Content: Fixed an issue where the emoji dropdown would not be fully visible

🐛 Bugs Eaten (by Owlbert)

• Editor: Fixed an issue where generating the page description with AI was failing
• Auth: Fixed an issue where projects couldn’t be switched from SAML back to using a ReadMe login
• Versions: Fixed an issue where projects with a large number of versions couldn’t unpublish them
• Versions: Fixed an issue where certain versions weren’t appearing in the project dashboard
• Recipes: Fixed an issue where Recipes didn’t have the correct meta tags
• API Reference: Fixed an issue where $refs that were null crashed the page
• API Reference: Fixed an issue with deleting an object field from the manual API editor
• PDF Generation: Fixed an issue where nested content wasn’t included in the generated PDF
• Docs: Updates to our icon library

Improvements

• SSO: Added OpenID Connect as an option for end users
• Developer Dashboard: My Requests can now show Try It requests while logged out
• Developer Dashboard: Opening an expired shared request now loads the page with expiration info in the response
• Developer Dashboard: Added x-documentation-url header info to response details
• Global Landing Page: If a description is not provided, we now use the project description for improved SEO
• API Reference: Added webhook icon to the sidebar to make it easier to tell which endpoints are webhooks
• Editor: Improved support for writing longer descriptions

🐛 Bugs Eaten (by Owlbert)

• Search: Fixed an issue where project name letter casing was not being updated
• Developer Dashboard: Fixed an issue with a non-loading graph in My Requests
• Developer Dashboard: Fixed an issue where request history wasn’t being preserved when server variables are changed
• Developer Dashboard: Fixed an issue where Slack notifications weren’t working or displaying the correct icons
• Doc Metrics: Fixed an issue where the graphs would not load
• Navigation: Fixed an issue where the dropdown navigation menu would briefly display the incorrect page
• Navigation: Fixed an issue where adding a ? to the URL on Changelog and Reference pages would prevent the page from loading
• SSO: Fixed an issue where group mappings could stop working
• Global Landing Page: Improved performance by removing an unnecessary redirect
• Owlbot AI: Fixed an issue where CSV exports would be formatted incorrectly
• Manual Editor: Fixed an issue where creating new pages would fail
• PDF Export: Fixed an issue where PDFs weren’t being generated sometimes
• API Reference: Fixed an issue where enum objects with default values were selected, even when defaults were not enabled
• Editor: Fixed an issue where errors would be shown on embeds URLs before a URL is entered
• Editor: Fixed an error when saving Reusable Content
• Enterprise: Fixed an issue where project passwords were not editable from the Group dashboard

Setting up your Developer Dashboard with AWS API Gateway is easier than before. Get API keys in your docs and understand your API customers, by setting up within your AWS Console. Find the new setup steps from your Admin Dashboard → My Developers → Set Up API Keys and select the API Gateway tab.

Improvements

• Landing Page: Added support for OpenGraph images
• API Reference: minLength and maxLength are now better surfaced in the UI
• SSO: SAML verification codes are now easier to spot in your emails
• Custom Domains: Some projects will see a new custom domains setup page

🐛 Bugs Eaten (by Owlbert)

• SSO: Fixed an issue with an empty safelist and authentication errors
• Editor: Fixed an issue where JSX comments would cause the page to crash
• Editor: Fixed an issue where back-to-back Reusable Content blocks could fail to render
• Editor: Fixed an issue where files could be mixed up on upload
• API Reference: Fixed an issue where base URLs in the request code is not persisted on refresh
• API Reference: Fixed a recent regression where parameter inputs weren’t reset between endpoint pages
• Suggested Edits: Fixed an issue where non-merged Suggested Edits would update the last updated timestamp
• Inviting Users: Fixed an issue where inviting users could sometimes fail
• Docs: Fixed an issue where you couldn’t navigate to a parent page if it was an endpoint

We've made improvements to Enterprise Staging when promoting your changes to production to make it clearer which changes will be going live. We now show a breakdown of who made changes and which sections are affected.

Improvements

• Developer Dashboard: When viewing an API Log, the list of headers is now collapsible.
• Developer Dashboard: Add an error rate chart that shows what percentage of requests errored across all of your developers.

🐛 Bugs Eaten (by Owlbert)

• Editor: Fixed the issue where the Reusable Content menu was preventing writing HTML in the editor.
• API Reference: Fixed the issue where a schema object property being set to null caused the page to crash.
• API Reference: Fixed the issue where optional objects with required properties were incorrectly being displayed as required objects.
• API Reference: Fixed the issue preventing switching an endpoint page back to a normal page in the dashboard.
• Reusable Content: Fixed the issue where Reusable Content blocks with special characters in their name couldn’t be deleted.
• Discussions: Fixed the issue preventing users from completing reCAPTCHA verification for suspected spam.
• Quick Switcher: Fixed the issue navigating to Guides and API References via the dashboard quick switcher.
• SEO: Fixed some admin routes not being disallowed in robots.txt.
• Search: Fixed links to reference pages returned via the search API endpoint.

Improvements

• Auth: Allow end users to request access from the protected page screen

🐛 Bugs Eaten (by Owlbert)

• SEO: Improve UX for generating an SEO description with AI
• SEO: Fixed blank title tags in some server-rendered HTML
• Recipes: Fixed layout issue with Recipes endpoint picker
• Recipes: Fixed issue where Recipe code overlapped with line numbers on initial load
• Signup: Fixed issue where validation errors during signup prevented progressing
• API Reference: Fixed issue causing default values for enums to be displayed twice
• API Reference: Fixed issues for callbacks with additionalProperties displaying incorrectly

Improvements

• API Reference: More descriptive variable name in api code samples
• API Reference: Display min/max values for parameters more prominently
• API Reference: Improved styling of parameter objects with multiple levels of nesting
• Guides: Strip style tags when generating metadata for SEO
• Project Dashboard: Make searching for users by email case insensitive
• Developer Dashboard: Improved Demo experience if project doesn’t have any recent API logs

🐛 Bugs Eaten (by Owlbert)

• Auth: Fixed issue where updating end user SSO configuration incorrectly modified redirect URI
• Guides: Fixed issue where pages with empty HTML blocks caused page to error
• Variables: Fixed issue where variables were sometimes being saved in correctly in the editor
• API Reference: Fixed issue where certain Try It responses would cause page to error
• API Reference: Polymorphic objects with custom keywords will render correctly

Improvements

• Billing: Added billing details UI, so you can see the total amount of your invoices, next payment, and more!
• Favicons: We now convert SVG icons for broader browser support on upload
• API Explorer: Parameter inputs are now hidden when custom code samples are defined in your OAS file
• SDK: Generated SDK code is a little more personal

🐛 Bugs Eaten (by Owlbert):

• Recipes: Fixed an issue where users couldn’t remove emojis from a Recipe
• Billing: Fixed an issue where trial project navigation wasn’t working
• Billing: Fixed an issue where the next invoice would show the incorrect date
• Billing: Fixed an issue where add-on UI would show costs to the 4th decimal
• Developer Dashboard: Fixed an issue where the spend breakdown would show the incorrect amount
• API Explorer: Fixed an issue where authentication was not persisting across projects with the same domain
• Dashboard: Fixed an issue with SVG uploads not working
• Navigation: Fixed an issue with custom links not properly navigating users
• Integrations: Updated Google Analytics copy for clarity