Docs Redirector
What is this?¶
This page provides a method for content documentation with anchor-based linking to reliably link to official documentation pages without needing to have a local development copy of the docs.
How to use this¶
This page can be referenced with the ?ref=doc_slug_id
to create a path like /redirect/?ref=rs_model_template
or /redirect/?ref=#rs_model_template
Here is an example link using the ?ref=rs_model_template
query string.
Images and Built Images can be referenced by using ?ref=images-<filename>
or ?ref=built_images-<filename>
.
How this works¶
This page contains a map of "slugs" to doc page links compiled from the documentation during the build process.
It can use to take "slugs" like rs_model_template
and convert it into its respective doc destination.
The JavaScript on this page reads the ?ref=
query string argument from the URL, checks if it exists in the map of "slugs", then redirects a user, such as yourself, to the next page.