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

Protected Documentation

Control who gets access to your docs

📘

Protection for all pages

Documentation can be either internal/protected or public. To have both you will need two projects.

Public Docs: Docs can be viewed by anyone.
Project Members Only: Only users with ReadMe accounts and admin permissions can view.
Site-wide Password: One password for the whole site. Anyone with the password can view. Cookie lasts 7 days.

📘

Note

The protection level in Trial Mode is always Project Members Only.

Login Expiration

Authentication persists via browser cookies. You can set a custom expiration period under "advanced options" in Variable Defaults to require your users to log in again after a certain timeframe. The default setting is shown below.

Updated about a month ago


Protected Documentation


Control who gets access to your docs

Suggested Edits are limited on API Reference Pages

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