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

(docs) update /clerk guide #62

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

Conversation

alexisintech
Copy link
Contributor

@alexisintech alexisintech commented Mar 19, 2025

Clerk employee here 👋 While updating the Clerk docs' Convex integration guide (PR), I noticed this guide could use some love. From the Clerk Docs team to yours 💜

Notes about the changes:

  • The Tanstack Start link 404'd, so I updated it, but you'll see that it's moved farther down the page into a Tanstack Start section. This may get moved to the top again pending on your feedback about this next point:
  • I've added a Next.js section, which bloats the page, and I think could get moved to https://docs.convex.dev/client/react/nextjs/with-clerk similar to how you do it for Tanstack Start. Let me know what you think and I can update the PR because I have an idea of how to reorganize this guide once that Next.js section is moved.
  • Updated the steps thoroughly.
  • Removed "Login and logout Flows" and combined it with "Logged-in and logged-out views". Ensured that this section is available in both the React and Next.js sections. I removed them as "supplemental" (at the bottom of the guide) sections because they are already included in the React/Next.js set ups, and its repetitive information. Plus, the guide now mentions to users to use the React setup guide if their guide isn't listed. So if they're using Expo, or any other React-based SDK, this information is still available on the page for them.
  • Removed "Next.js, React Native Expo, Gatsby" in favor of the new addition at the top of the guide (the first paragraphs under "Getting started"). Now when a user hits the page, and they say "wait this is for React, what about my SDK?" They are immediately presented with information about what to do if their SDK isn't listed.
  • Rewrote "Configuring a React client" to "Configuring Clerk's API keys" as that seems to be the purpose of the section - configuring Clerk's keys in dev vs. prod instances. Updated the copy here to be more clear about the intended purpose of the section.

Lastly, there are some TODO's. And there are code examples that you may want in your <TSAndJSSnippet> component. Let me know what you think - these are heavy changes, so please feel free to even set up a call and tackle it together :) I love good docs, and want anything Clerk-related to be top notch 😻💜

Cheers 😸💖


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

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

Successfully merging this pull request may close these issues.

1 participant