Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK-1690] Add generated API docs #25

Merged
merged 23 commits into from
Jun 4, 2020
Merged

[SDK-1690] Add generated API docs #25

merged 23 commits into from
Jun 4, 2020

Conversation

adamjmcgrath
Copy link
Contributor

@adamjmcgrath adamjmcgrath commented Jun 1, 2020

Description

Generate API Docs using typedoc
(Will update the README with a link to the docs when the repo is public and I can publish the docs folder on github.io)

References

image

image

image

Checklist

  • I have added documentation for new/changed functionality in this PR or in auth0.com/docs
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used, if not master

# Conflicts:
#	docs/assets/js/search.json
#	docs/globals.html
#	docs/index.html
#	docs/interfaces/advancedoptions.html
#	docs/interfaces/auth0clientoptions.html
#	docs/interfaces/auth0contextinterface.html
#	docs/interfaces/auth0provideroptions.html
#	docs/interfaces/authstate.html
#	docs/interfaces/getidtokenclaimsoptions.html
#	docs/interfaces/gettokensilentlyoptions.html
#	docs/interfaces/gettokenwithpopupoptions.html
#	docs/interfaces/getuseroptions.html
#	docs/interfaces/logoutoptions.html
#	docs/interfaces/popupconfigoptions.html
#	docs/interfaces/popuploginoptions.html
#	docs/interfaces/redirectloginoptions.html
#	docs/interfaces/redirectloginresult.html
#	docs/interfaces/withauth0props.html
#	src/auth0-context.tsx
#	src/index.tsx
#	src/utils.tsx
#	typedoc.js
@adamjmcgrath adamjmcgrath added the medium This PR may require moderate effort to action, or contains many changes to review label Jun 1, 2020
@adamjmcgrath adamjmcgrath requested a review from a team June 1, 2020 11:17
lbalmaceda
lbalmaceda previously approved these changes Jun 3, 2020
package.json Show resolved Hide resolved
# Conflicts:
#	package-lock.json
#	src/auth0-provider.tsx
@adamjmcgrath adamjmcgrath merged commit beaec8f into master Jun 4, 2020
@adamjmcgrath adamjmcgrath deleted the typedoc branch June 4, 2020 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
medium This PR may require moderate effort to action, or contains many changes to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants