This repository contains all Auth0 documentation content (including Quickstarts).
Please review the Contributing Guidelines before sending a PR or opening an issue.
- If you are looking for the application that hosts the Docs content, see auth0-docs.
- If you would like to modify the Management API v2 API docs, they are generated from the api2 repository.
Both of the above repositories require team access.
- You can edit Docs content by using the GitHub web editor and editing a file. This is best suited for typos and small changes.
- You can also pull down the
/docsrepo to your computer via Git and edit files in your local editor, before pushing a new branch (or a branch to your own fork of the project). You can then go to github.com and start a PR. We will be able to review the changes in a Heroku test application prior to merging. - Lastly, you can run and test the docs site locally (access available to Auth0 employees only). This option is best suited for repeat contributors or for complex contributions. You gain the benefit of locally testing and viewing your changed or added pages, navigation, and config, but you also gain the complexity of dealing with the local docs app, setting it up, and keeping it updated.
Regardless of which option you use, again, please review any relevant sections of the Contributing Guidelines before sending a PR.
If you find a bug or inaccuracy in the documentation content, please report it in this repository's issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
This project is licensed under the MIT license. See the LICENSE file for more info.