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

Create an FAQ to help your users find the most useful questions

Create an FAQ

Admins can create an FAQ by adding any question from the forum, or by creating their own question and adding it. The FAQ is then displayed in the left hand menu.

Add a question

Make sure you are logged in as an administrator, then find the "add to FAQ" button for each question.

Here it is really big:

Once a question is added, admins may remove comments to show the most helpful response or add their own.

Admins can also add their own questions by clicking "Ask a Question" to create their own question, then using the same process.

Remove a question

If a question has been added to the FAQ, the button will change to "remove from FAQ". Click it to do that!

Disabling the FAQ

The FAQ can be disabled by removing all of the added FAQ questions. Simply click on each question, and select "Remove from FAQ". When there are no questions left, the FAQ link will disappear.

Updated 9 months ago


Suggested Edits are limited on API Reference Pages

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