This is the repository for the Auth0 documentation.

• Always use absolute links
• Do not hard code links to auth0 sites like docs.auth0.com, manage.auth0.com, etc. Use variables instead such as @@uiUrl@@
• Do not store images in external locations like Dropbox, CloudUp, or the Auth0 CDN. Link to images in this repo using ![](/media/folder/image_name.png). The image will get automatically uploaded to the CDN and the link will be transformed.

Test Procedures

When testing a document or tutorial below are several areas to look for.

1. Ensure that the code in the tutorials is correct and functions as expected
2. Ensure that the steps (1..n) are in an order that makes sense and that there are no missing or duplicate steps.
3. Check for broken links
4. Check for old screenshots (both in auth0's dashboard/product and on referenced third-party sites)
5. Ensure that the code in the seed project that you download functions as expected
6. Check for outdated dependancies (both auth0 dependancies and third-party i.e. node modules, nuget packages, gems, etc.)

Quickstarts

All quickstart data now comes directly from the docs API at /meta/quickstart. This means that the quickstart on docs and manage will both consume the same datasource and will always be up to date. To add a new quickstart you simply need to add the markdown document in the appropriate folder: server-apis, server-platforms, native-platforms, or client-platforms. The only requirement is that you need to specify the correct front matter.

For all quickstart docs, provide the following:

---
title: Document Title
name: Quickstart Name
image: //cdn.auth0.com/path/to/icon.png
thirdParty: true|false  # For server apis only
hybrid: true|false # For native platforms only
---

After you publish the doc update, the new quickstart will automatically appear on both docs and manage.

Additionally, the quickstart configuration is also in this repository here: quickstart.yml.