The Getting Started page shows developers how to use your API as quickly as possible. Sometimes, you want to start with a slightly more complicated request, so the Getting Started page now includes all parameters and headers that make up the request.
🪶 Other Improvements
Reusable Content: Added the ability to search the page usage list
API Reference: APIs using custom code samples will no longer show auto-generated samples
Documentation: We’ve refactored some of our documentation login pages; they may look a little different, but you should see no change in functionality
🐛 Bugs Eaten (by Owlbert)
Developer Dashboard: Fixed an issue where the Getting Started or Authentication pages could be in a broken state when the endpoints used on those pages are deleted
Developer Dashboard: Fixed an issue where API keys menu on the My Requests page wasn’t working
Developer Dashboard: Fixed an issue where duplicated query parameters would appear when replaying requests
Documentation: Fixed an issue where users couldn't log in via passwordless login
Documentation: Fixed an issue where the Jump To menu weren’t showing endpoints nested 2 levels deep
Enterprise: Fixed an issue where selecting a deprecated version in some enterprise projects would load a blank page
Variables: Fixed an issue where project admins could edit group-level variables
API Reference: Fixed an issue where server variables were incorrectly marked as invalid
API Reference: Fixed an issue where resetting server variables without a default would show undefined
Custom Page: Fixed an issue where custom JS would load twice when custom pages were used as an error page
Editor: Fixed a bug when bolding text in list items
Translations: Fixed an issue where users couldn’t save after removing a language
ReadMe now supports webhooks documented in your OAS 3.1 files. Try it out with an example webhooks specs.
ReadMe Labs
We’ve added ReadMe Labs in the dashboard so you can enable experimental features—just GraphQL for now. You can find it under configuration settings, which we’ve reorganized to make your settings easier to find.
We’ve added Reusable Content! You can create blocks in the editor via the command menu /. You can reuse any combination of blocks you already have in the editor across guides and reference pages. Read more
🪶 Other Improvements
Developer Dashboard: Try It requests will populate with user emails if the user is logged in without any configuration required
Editor: Callout headings are now h2 tags for improved accessibility
Editor: Reordering pages are now faster and more reliable
SAML: Added an optional redirect URL on log out
Owlbot AI: Updated AI model for more detailed responses and larger prompts (via GPT-4 Turbo)
🐛 Bugs Eaten (by Owlbert)
Developer Dashboard: Fixed an issue where webhook URL couldn’t be removed
Developer Dashboard: Fixed an issue with deleting custom variables rendering incorrect variables key names
Editor: Updated outdated copy when adding your first first API
Editor: Fixed an issue where reordering pages updated the timestamps of all pages
Editor: Fixed an issue where you couldn’t save changes to pages after navigating from staging
SEO: Fixed meta info not appearing when sharing links to Twitter
Search: Fixed an issue where deleted endpoint pages weren’t being removed from search results
Search: Fixed an issue where reindexing would fail if a project contained orphaned pages
Enterprise: Fixed an issue with some projects not inheriting custom CSS from their parent
Enterprise: Fixed an issue where changing a user role would change roles for multiple users
API Reference: Fixed an issue where Try It requests were not working
Login: Fixed an issue where admin logins on password protected pages weren’t redirecting to the correct page
We've added API access to ask Owlbot AI questions programatically to our Enterprise plan. This enables customers to embed Owlbot functionality directly within their product or wherever else information from documentation could be useful. View documentation on how to make a call here.
Generate SEO Metadata Description With AI
When editing SEO metadata you can automatically generate a short description of the page with AI.
🐛 Bugs Eaten (by Owlbert)
Auth: Fixed issue where SAML End Users weren't getting updated permissions
Slack Integraiton: Improved reliability of Slack notifications delivering
Owlbot AI: Improve performance and reliability of Owlbot AI exports
Developer Dashboard: Better communicate expiration of log URLs
Documentation: Fixed issues with navigating from 404 pages with the back button
SEO: Sitemap URL will now always be absolute in robots.txt
SEO: Fix showing the sitemap in robots.txt for enterprise projects
SEO: Only show entry in sitemap if the page has content
Editor: Fix issue where the editor toolbar wouldn't always appear in the Changelog
Favicon: Always show the uploaded favicon at /favicon.ico
We've added the ability to customize how Owlbot responds to questions it is asked. You can tweak the tone it uses, the length of responses, prevent it from using specific words in the response (such as competitors), and set your own default response when it doesn't know an answer.
SEO Improvements
Customers now have more control over specific SEO settings in their documentation. You can now edit metadata keywords for pages, disable robots.txt on a per project basis, and add a noindex tag to specific pages.
🪶 Other Improvements
GraphQL Beta: Adds instructions for providing auth via a custom webhook directly in the product
Developer Dashboard: Add a new slack group for users looking to get started and ask questions. Come say hi!
🐛 Bugs Eaten (by Owlbert)
Recipes: Fix copy code button
Project Export: Fix export for versions with specific semver formats
Owlbot: Fix jumpiness when typing in the documentation
ReadMe added the ability for users to view all of their API calls directly in the reference section. We brought all of the filters and graphs from the My Developers page in the admin dashboard into the documentation. Users can user this to easily see how they are using an API and debug any issues they might have. Learn more about this and related features here: https://blog.readme.com/customize-dx-developer-dashboard/
🪶 Other Improvements
API Reference: API Keys in the reference section are now sorted by most recently used.
🐛 Bugs Eaten (by Owlbert)
Owlbot AI: Continued fixing indexing issues including better handling of special characters and large OAS files.
Owlbot AI: Fixes issues with using keyboard shortcuts with Owlbot and improves a11y support.
My Requests: Fix link to view all requests from the endpoint page appearing even if the feature is disabled.
Auth: Fixed removing a teammate sometimes not correctly updating permissions for users already logged into the hub.