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

Redirect Scenarios

This page describes how to handle redirects for different scenarios involving multiple projects and custom domain changes. For the basics on redirects, see Error Pages.

Note all redirects must be relative paths (i.e., paths that start with a "/" and that come after the main site domain).

Redirects in one project

Configure redirects on your project's dash at:
dash.readme.io/project/yourProject/errors.

If you're working in a single project, you typically author redirects using the following relative path pattern:
/docType/pageSlug
For example, if you had a page in your Guides section named intro-page, and you changed it getting-started, you'd author this line:

/docs/intro-page -> /docs/getting-started

301 redirects for changed custom domains

If you change your custom domain (for example, because you are upgrading to enterprise), then you can't simply create redirects in your project's dash. Instead, your company's developers or site admins have to create the 301 redirects on your side. For example, if you serve your site using Apache, you set up 301 redirects in the server's .htaccess config file.

Redirects for grouped projects

If you have an Enterprise group project with multiple child projects, configure redirects at:
dash.readme.io/group/yourParentProject/errorpages
In other words, you configure all redirects on the parent project's dashboard, not on the child projects.

You author redirects using the following relative path pattern:
/projectSubdomain/docType/pageSlug.

For example, if you renamed a page from intro-page to getting-started in the Guides section of the product-1 project, you'd author this line:

/product-1/docs/intro-page -> /product-1/docs/getting-started

Validating links

To test for broken links once you create redirects, you can use third-party tools. For more information see Link to pages

Remember to update redirect when you upgrade to a group project

If you're upgrading a project to become an Enterprise group project, remember to remove page redirects from all child projects, and remember to update all page slug redirects with the project subdomain. In other words, your old relative paths in the child projects were:
/docType/pageSlug
and your new relative paths in the parent project are:
/projectSubdomain/docType/pageSlug

For more information see https://docs.readme.com/guides/docs/upgrading-to-group-project.

Updated 24 days ago



Redirect Scenarios


Suggested Edits are limited on API Reference Pages

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