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

We have implemented a more powerful search using Algolia to help your users find the articles they are searching for even faster.

You can find the search in the fixed navigation bar:

As you type, you should see the bolded search term listed out in a drop down with the surrounding text:

The search will populate the top 3 items from each category.

Enterprise Global Search

If you are an enterprise customer with several child projects unified under one parent project's custom domain, then your users can search across all the projects that they have access to. Users cannot exclude results by project or limit search to one project. However, users can see which project the result belongs to using the search results preview.

Updated about a month ago


Search


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.