Skip to content

(convex) guide overhaul #2119

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
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

(convex) guide overhaul #2119

wants to merge 9 commits into from

Conversation

alexisintech
Copy link
Member

@alexisintech alexisintech commented Mar 19, 2025 •
edited
Loading

What does this solve?

  • We received user feedback that the Convex docs were out of date, and also requests for Next.js instructions.

What changed?

  • Updates copy overall to better match Docs voice and to ensure all information is up to date
  • Removes screenshots
  • Adds Next.js instructions

Fixes DOCS-10110

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

@alexisintech alexisintech requested a review from a team as a code owner March 19, 2025 17:53
@NWylynko
Copy link
Contributor

Imma run through this, I've never used convex before so should be a good test

@alexisintech alexisintech mentioned this pull request Mar 19, 2025
Closed
NWylynko
NWylynko reviewed Mar 20, 2025
View reviewed changes
docs/integrations/databases/convex.mdx Outdated
Convex is the full-stack TypeScript development platform. With Convex you get to build a backend with a provided realtime database, file storage, text search, scheduling and more. Paired with Clerk's user authentication and management features, you can build a powerful application with minimal effort.

This tutorial assumes that you have already [set up a Clerk application](/docs/quickstarts/setup-clerk) and a [React + Convex application](https://docs.convex.dev/quickstart/react){{ target: '_blank' }}. This tutorial will also assume that you have not added Clerk to your application yet.
With [Convex](https://www.convex.dev/), you can build a backend with a provided realtime database, file storage, text search, scheduling and more. Paired with Clerk's user authentication and management features, you can build a powerful application with minimal effort. This tutorial will show you how to integrate Clerk into your Convex application. It assumes that you have already integrated one of Clerk's SDKs into your application.
Copy link
Contributor

@NWylynko NWylynko Mar 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
With [Convex](https://www.convex.dev/), you can build a backend with a provided realtime database, file storage, text search, scheduling and more. Paired with Clerk's user authentication and management features, you can build a powerful application with minimal effort. This tutorial will show you how to integrate Clerk into your Convex application. It assumes that you have already integrated one of Clerk's SDKs into your application.
With [Convex](https://www.convex.dev/), you can build a backend with a provided realtime database, file storage, text search, scheduling and more. Paired with Clerk's user authentication and management features, you can build a powerful application with minimal effort. This tutorial will show you how to integrate Clerk into your Convex application. It assumes that you have already integrated one of Clerk's SDKs into your application and integrated Convex.

I don't feel its clear that this guide doesn't cover setting up convex

Copy link
Member Author

@alexisintech alexisintech Mar 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

ahh it does say it in the sentence before "This tutorial will show you how to integrate Clerk into your Convex application.", but I can say it twice and have it say "This tutorial will show you how to integrate Clerk into your Convex application. It assumes that you have already integrated one of Clerk's SDKs into your Convex app." if that wasn't clear

Copy link
Contributor

Choose a reason for hiding this comment

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

Yea I get what your saying, I definitely just glossed over 'your Convex application', but yea to me it wasn't clear that I already needed both Clerk and Convex setup, this is simply just wiring them together.

NWylynko
NWylynko approved these changes Mar 20, 2025
View reviewed changes
Copy link
Contributor

@NWylynko NWylynko left a comment

Choose a reason for hiding this comment

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

Great guide! everything worked as expected, didn't run in to any problems.

@alexisintech alexisintech changed the title update convex integration guide (convex) guide overhaul Mar 20, 2025
convex-copybara bot pushed a commit to get-convex/convex-backend that referenced this pull request Apr 28, 2025
@thomasballinger @alexisintech
convex-backend PR 62: (docs) update /clerk guide (#36729)
db14b90 
Clerk employee here 👋 While updating the Clerk docs' Convex integration guide [(PR)](clerk/clerk-docs#2119), 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](https://docs.convex.dev/client/react/tanstack-start/tanstack-start-with-clerk). 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.

----

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

Co-authored-by: Alexis Aguilar <[email protected]>
GitOrigin-RevId: 7d0a4d77322ce143ed8af1712b0306a3efa3e36c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NWylynko NWylynko NWylynko approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alexisintech @NWylynko