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

Handling Redirects

Redirects work similarly to as you would handle them in a regular project. However, for the enterprise group, child redirects will be omitted and the enterprise group will be taken into consideration.

If you have child redirects configured for your enterprise project, move your redirects to the enterprise dashboard and be sure to include the child project subdomain in the redirect

For example, in a single project it is sufficient to write:

/docs/this -> /docs/that

but in the Enterprise Parent Group you must include the child project subdomain:

/projectname/docs/this -> /projectname/docs/that

Handling Redirects

Suggested Edits are limited on API Reference Pages

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