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

(convex) guide overhaul #2119

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

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

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

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

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.

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
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.

2 participants