Guides

Guidance on Guides 📘

Think of Guides as the instruction manual for your API: share tips on getting started, authentication details, or more context on what’s possible with your API. It’s easy to write content using our Markdown editor, add images or GIFs, embed videos, tables, code samples, and more!

We recommend using this section to get your user primed to consume your API or product, including pages on what your API or product does and how to access it.

Guides are also a great place to create tutorials, in-depth descriptions and schema tables, examples, edge cases, and workflow explainers.

Creating Guides From Your Dashboard

To start creating Guides, head to your Dashboard > Documentation > Guides.

Guides Best Practices

There is no page limit when it comes to Guides—the sky's the limit 🚀. We do however recommend organizing your Guides pages in a way that is easy for your users to navigate. Head to our documentation best practices doc for more tips on how to create accessible and easy-to-understand content for your users!

The first step to creating your new documentation is to add page categories. Each of the documentation pages you write in ReadMe must be within a category! Creating Categories are a great way to organize your content and help users easily locate what information is most relevant to them. For example, ReadMe's Guides include categories like "QUICK START" and "PROJECT SETUP."

Within each category, you can create pages which are always available from the Guides sidebar in your project hub, and subpages, which are nested pages which users can find via a page dropdown. There are two levels of subpages: first-level subpages, which are nested underneath parent pages, and second-level subpages, which are nested underneath first-level subpages.