Product Guide

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started
added

API Explorer v6: allOf Support, Better Errors, and More!

Posted by Marc Cuva 5 days ago

Today we released a new major version of our API Explorer! This release has been months in the making, and adds support for some highly requested features, fixes a ton of bugs and oddities, and more!...

improved

Cache Improvements

Posted by Gabriel Ratcliff 6 days ago

Last week, we migrated our application cache layer under Cloudflare's proxy umbrella! We already take advantage of their certificate management s...

added

Slack Integration

Posted by Kanad Gupta 3 months ago

You can now receive notifications for activity on your ReadMe project in your Slack workspace :tada+: this integration supports the following types of notifications off the bat: - **[Suggested Edits](d...

improved

Say hello to dash.readme.com! 🎉

Posted by Dom Harrington 3 months ago

Earlier this year, we purchased the readme.com domain for our homepage. Starting today, the ReadMe dashboard is accessible at dash.readme.com! We reco...

fixed

No Version in Changelog and Custom Pages API

Posted by Kanad Gupta 4 months ago

As part of the rollout of the Changelog and Custom Pages API, we had initially required a x-readme-version header. The Changelog and Custom Page objects are not versioned the same way that they are ...

improved

Enterprise Identity Improvements

Posted by sean dokko 4 months ago

We're excited to announce a couple of new updates to the enterprise members' management section.

improved

Updates to Audit Logs

Posted by sean dokko 4 months ago

We released an iteration to Audit Logs for our enterprise projects! Here are some of the new features we're excited about: - We've added the project column to the audit logs: though you can speci...

improved

Prettier API Parameters

Posted by Rafe Goldberg 4 months ago

Hey there—just us, ReadMe, again! We've been hard at work polishing the way we display API parameters in our reference sections. The headliner here is an updated layout that's way more flexible, so yo...

added

Automatically Sync API Specification with GitHub Actions

Posted by Marc Cuva 5 months ago

We just released a GitHub Action for automatically syncing an API Spec file directly from a GitHub repo! GitHub Actions are packages you can include in your GitH...

improved

New Navigation and Project Dashboard

Posted by Marc Cuva 5 months ago

We’ve made a lot of changes to our dashboard to make things easier to find, and added more information about your project and ReadMe to the Project Dashboard! For more information about these changes...