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

[DO NOT MERGE] Sign-in-or-up docs #1772

Open
wants to merge 31 commits into
base: main
Choose a base branch
from

Conversation

alexcarpenter
Copy link
Member

@alexcarpenter alexcarpenter commented Dec 4, 2024

Explanation:

Resolves SDKI-747

We are introducing a combined sign-in-or-up flow that will be the default experience using the <SignIn /> component. Users will be able to still opt-in to a custom <SignUp /> page by adding a custom sign-up route along with setting their CLERK_SIGN_UP_URL.

This update will also default Account Portal to using the combined flow, instead of having separate sign-in sign-up pages.

This PR:

  • Introduce documentation on combined sign-in-or-up flows using <SignIn /> component
  • Introduce redirect https://github.com/clerk/clerk/pull/853
    // redirects/dynamic/docs.jsonc
    {
      "source": "/docs/references/:path/custom-signup-signin-pages",
      "destination": "/docs/references/:path/custom-sign-in-or-up-page",
      "permanent": true,
    },
    // redirects/static/docs.json
    {
      "source": "/docs/references/expo/web-support/custom-signup-signin-pages",
      "destination": "/docs/references/expo/web-support/custom-sign-in-or-up-page",
      "permanent": true
    }

Checklist

  • I have clicked on "Files changed" and performed a thorough self-review
  • I have added the "deploy-preview" label and added the preview link(s) to this PR description
  • All existing checks pass

Copy link

github-actions bot commented Dec 4, 2024

Hey, here’s your docs preview: https://clerk.com/docs/pr/1772

@alexcarpenter alexcarpenter changed the title [WIP] Sign-in combined flow docs [WIP] Sign-in-or-up combined flow docs Dec 9, 2024
@alexcarpenter alexcarpenter changed the title [WIP] Sign-in-or-up combined flow docs [WIP] Sign-in-or-up docs Dec 10, 2024
@alexcarpenter alexcarpenter mentioned this pull request Dec 10, 2024
3 tasks
@alexcarpenter alexcarpenter changed the title [WIP] Sign-in-or-up docs [DO NOT MERGE] Sign-in-or-up docs Dec 13, 2024
@alexcarpenter alexcarpenter marked this pull request as ready for review December 13, 2024 19:11
@alexcarpenter alexcarpenter requested review from a team as code owners December 13, 2024 19:11
Copy link
Member

@alexisintech alexisintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks so much for collaborating 😸💖

@alexcarpenter
Copy link
Member Author

Thank you! Will hold off on merging until this goes live. I will be sure to keep it up to date with main,

Copy link
Contributor

@zchsh zchsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! 💯 🤩

  • 👀 I skimmed all the pages linked in the PR description
  • ⛏️ For those PR description links, I had to adjust some signup vs sign-up differences in the URLs, which is pretty nitpicky so def feel free to ignore. I couldn't find any actual broken links in the docs themselves (... do we have a broken link checker?)
  • ❓ I found a lil typo-ish bug in the Expo sidebar, I think at some point the useOauth() item got dropped and replaced with a duplicate sign-in-or-up link

docs/manifest.json Outdated Show resolved Hide resolved
docs/manifest.json Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you still need to add the custom-sign-up-page routes for all of these

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in. a647b31

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants