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.

Sign up for GitHub

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

Jump to bottom

Improve API docs [SDK-3562] #796

Merged
merged 9 commits into from
Sep 1, 2022
Merged

Improve API docs [SDK-3562] #796

merged 9 commits into from
Sep 1, 2022

Conversation

Widcket
Copy link
Contributor

@Widcket Widcket commented Aug 31, 2022

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

📋 Changes

This PR improves the API docs by:

  • Adding connection and connection_scopes query parameters to the AuthorizationParams type in login.ts and its API docs (scope, audience, organization, and invitation are already typed)
  • Adding some notes mentioning the need to request offline_access to get a refresh token from Auth0
  • Adding some missing API documentation
  • Fixing a few internal links
  • Fixing the syntax of a few code samples
  • Applying the word list from Docs team
  • Applying appropriate Markdown and TSDoc formatting
  • Fixing punctuation mishaps

Screen Shot 2022-08-30 at 20 24 54

@Widcket Widcket added the review:large Large review label Aug 31, 2022
@vercel
Copy link

vercel bot commented Aug 31, 2022 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Updated
nextjs-auth0 ⬜️ Ignored (Inspect) Sep 1, 2022 at 2:59PM (UTC)

@adamjmcgrath
Copy link
Contributor

lgtm 👍

Widcket
Widcket commented Sep 1, 2022
View reviewed changes
src/frontend/use-user.tsx Outdated Show resolved Hide resolved
Widcket
Widcket commented Sep 1, 2022
View reviewed changes
src/frontend/use-user.tsx Outdated Show resolved Hide resolved
@Widcket Widcket marked this pull request as ready for review September 1, 2022 14:59
@Widcket Widcket requested a review from a team as a code owner September 1, 2022 14:59
@Widcket Widcket merged commit f8ceb4f into vNext Sep 1, 2022
@Widcket Widcket deleted the docs/improve-api-docs branch September 1, 2022 15:04
@adamjmcgrath adamjmcgrath mentioned this pull request Oct 11, 2022
Merged
@adamjmcgrath adamjmcgrath mentioned this pull request Nov 30, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamjmcgrath adamjmcgrath adamjmcgrath approved these changes

Assignees
No one assigned
Labels
review:large Large review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Widcket @adamjmcgrath