diff --git a/docs/components/overview.mdx b/docs/components/overview.mdx index 63ef496652..30ef4f78aa 100644 --- a/docs/components/overview.mdx +++ b/docs/components/overview.mdx @@ -14,7 +14,7 @@ Control components manage authentication-related behaviors in your application. ## Customization Guides - [Theme components with the appearance prop](/docs/customization/overview) -- [Localize components with the `localization` prop (experimental)](/docs/components/control/clerk-loaded) +- [Localize components with the `localization` prop (experimental)](/docs/customization/localization) - [Add pages to the `` component](/docs/customization/user-profile) - [Add pages to the `` component](/docs/customization/organization-profile) diff --git a/docs/deployments/deploy-astro.mdx b/docs/deployments/deploy-astro.mdx index f0cba744c3..3e2fda6aa6 100644 --- a/docs/deployments/deploy-astro.mdx +++ b/docs/deployments/deploy-astro.mdx @@ -4,7 +4,7 @@ description: Learn how to deploy an Astro app to production with Clerk. --- > [!WARNING] -> This guide assumes that you have already installed Clerk in your application locally and are ready to deploy. If you haven't installed Clerk yet, please see our [guide to installing Clerk in your Astro application](/docs/quickstarts/astro) first. +> This guide assumes that you have already installed Clerk in your application locally and are ready to deploy. If you haven't installed Clerk yet, see [the quickstart guide.](/docs/quickstarts/astro) This guide will walk you through the steps to deploy your Astro app to production. diff --git a/docs/guides/authjs-migration.mdx b/docs/guides/authjs-migration.mdx index 98caa74756..8663c4eb9d 100644 --- a/docs/guides/authjs-migration.mdx +++ b/docs/guides/authjs-migration.mdx @@ -40,7 +40,7 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth. ### Install `@clerk/nextjs` - Clerk's Next.js SDK gives you access to prebuilt [components](/docs/components/overview), [hooks](/docs/references/nextjs/overview#client-side-helpers), and [helpers](/docs/references/nextjs/overview) for Next.js Server Components, Route Handlers and Middleware. Install it by running the following command in your terminal: + Clerk's Next.js SDK gives you access to prebuilt [components](/docs/components/overview), [hooks](/docs/references/nextjs/overview#client-side-helpers), and [helpers](/docs/references/nextjs/overview) for Next.js Server Components, Route Handlers and Middleware. Run the following command to install it: ```bash {{ filename: 'terminal' }} diff --git a/docs/integrations/databases/convex.mdx b/docs/integrations/databases/convex.mdx index 43dffd51e7..59667528c8 100644 --- a/docs/integrations/databases/convex.mdx +++ b/docs/integrations/databases/convex.mdx @@ -74,7 +74,7 @@ This tutorial assumes that you have already [set up a Clerk application](/docs/q ### Install `@clerk/clerk-react` - Install Clerk's React SDK by running the following command in your terminal: + Run the following command to install Clerk's React SDK: ```bash {{ filename: 'terminal' }} diff --git a/docs/integrations/databases/neon.mdx b/docs/integrations/databases/neon.mdx index 82f0694505..9d49b68a99 100644 --- a/docs/integrations/databases/neon.mdx +++ b/docs/integrations/databases/neon.mdx @@ -133,7 +133,7 @@ This tutorial demonstrates how to integrate Neon Postgres with Clerk in a Next.j }) ``` - 1. To push the schema to the database, run the following command: + 1. Run the following command to push the schema to the database: ```sh {{ filename: 'terminal' }} npx drizzle-kit push diff --git a/docs/integrations/webhooks/debug-your-webhooks.mdx b/docs/integrations/webhooks/debug-your-webhooks.mdx index ac09292051..115aa800ad 100644 --- a/docs/integrations/webhooks/debug-your-webhooks.mdx +++ b/docs/integrations/webhooks/debug-your-webhooks.mdx @@ -52,7 +52,7 @@ If you're having trouble with your webhook, you can create a basic response and ``` 1. Run your application. -1. Send a request to the test route by running the following command in your terminal: +1. Run the following command to send a request to the test route: ```bash curl -H 'Content-Type: application/json' \ -X POST http://localhost:3000/api/webhooks/test diff --git a/docs/integrations/webhooks/inngest.mdx b/docs/integrations/webhooks/inngest.mdx index 9331aa6879..2b643d007b 100644 --- a/docs/integrations/webhooks/inngest.mdx +++ b/docs/integrations/webhooks/inngest.mdx @@ -136,7 +136,7 @@ Now, you've extended the usefulness of Clerk webhook events even further to buil ## Testing webhook events using the Inngest Dev Server -During local development with Inngest, you can use the [Inngest Dev Server](https://www.inngest.com/docs/local-development) to run and test your functions on your own machine. To start the server, in your project directory run the following command: +During local development with Inngest, you can use the [Inngest Dev Server](https://www.inngest.com/docs/local-development) to run and test your functions on your own machine. Run the following command to start the server: ```sh {{ filename: 'terminal' }} npx inngest-cli@latest dev diff --git a/docs/integrations/webhooks/sync-data.mdx b/docs/integrations/webhooks/sync-data.mdx index d13b5f06f7..3795b32540 100644 --- a/docs/integrations/webhooks/sync-data.mdx +++ b/docs/integrations/webhooks/sync-data.mdx @@ -89,7 +89,7 @@ This guide can be adapted to listen for any Clerk event. ### Install `svix` - You will use [`svix`](https://www.npmjs.com/package/svix) to verify the webhook signature. Install it by running the following command in your terminal: + You will use [`svix`](https://www.npmjs.com/package/svix) to verify the webhook signature. Run the following command to install it: ```bash {{ filename: 'terminal' }} diff --git a/docs/quickstarts/astro.mdx b/docs/quickstarts/astro.mdx index 8b7f2de575..6c3eda1c7c 100644 --- a/docs/quickstarts/astro.mdx +++ b/docs/quickstarts/astro.mdx @@ -35,7 +35,7 @@ description: Add authentication and user management to your Astro app with Clerk Clerk's [Astro SDK](/docs/references/astro/overview) provides a set of components, hooks, and stores that make it easy to build authentication and user management features in your Astro app. - Add the SDK to your project by running the following command: + Run the following command to install the SDK: ```bash {{ filename: 'terminal' }} diff --git a/docs/quickstarts/expo.mdx b/docs/quickstarts/expo.mdx index a4f5e03640..f63a9520ba 100644 --- a/docs/quickstarts/expo.mdx +++ b/docs/quickstarts/expo.mdx @@ -31,7 +31,7 @@ description: Add authentication and user management to your Expo app with Clerk. ### Create an Expo app - Create a new Expo project and install the necessary dependencies by running the following command: + Run the following commands to create a new Expo project and install the necessary dependencies: ```bash filename="terminal" @@ -55,7 +55,7 @@ description: Add authentication and user management to your Expo app with Clerk. Clerk's [Expo SDK](/docs/references/expo/overview) gives you access to prebuilt components, hooks, and helpers to make user authentication easier. - Add the SDK to your project by running the following command: + Run the following command to install the SDK: ```bash filename="terminal" diff --git a/docs/quickstarts/express.mdx b/docs/quickstarts/express.mdx index f645a7a5e6..2e1148f957 100644 --- a/docs/quickstarts/express.mdx +++ b/docs/quickstarts/express.mdx @@ -73,7 +73,7 @@ Learn how to integrate Clerk into your Express backend for secure user authentic CLERK_SECRET_KEY={{secret}} ``` - This guide uses `dotenv` to load the environment variables. Install the package by running the following command: + This guide uses `dotenv` to load the environment variables. Run the following command to install it: ```bash {{ filename: 'terminal' }} diff --git a/docs/quickstarts/ios.mdx b/docs/quickstarts/ios.mdx index 9d6f05a761..22c50396d6 100644 --- a/docs/quickstarts/ios.mdx +++ b/docs/quickstarts/ios.mdx @@ -30,7 +30,7 @@ description: Add authentication and user management to your iOS app with Clerk. ### Install the Clerk iOS SDK - Follow the Swift Package Manager [instructions](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app) to install Clerk as a dependency. + Follow [the Swift Package Manager instructions](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app) to install Clerk as a dependency. When prompted for the package URL, enter [https://github.com/clerk/clerk-ios](https://github.com/clerk/clerk-ios). Be sure to add the package to your target. ### Load Clerk @@ -112,7 +112,7 @@ description: Add authentication and user management to your iOS app with Clerk. @State private var password = "" @State private var code = "" @State private var isVerifying = false - + var body: some View { VStack { Text("Sign Up") @@ -134,13 +134,13 @@ description: Add authentication and user management to your iOS app with Clerk. } extension SignUpView { - + func signUp(email: String, password: String) async { do { let signUp = try await SignUp.create( strategy: .standard(emailAddress: email, password: password) ) - + try await signUp.prepareVerification(strategy: .emailCode) isVerifying = true @@ -148,20 +148,20 @@ description: Add authentication and user management to your iOS app with Clerk. dump(error) } } - + func verify(code: String) async { do { guard let signUp = Clerk.shared.client?.signUp else { isVerifying = false return } - + try await signUp.attemptVerification(.emailCode(code: code)) } catch { dump(error) } } - + } ``` @@ -176,7 +176,7 @@ description: Add authentication and user management to your iOS app with Clerk. struct SignInView: View { @State private var email = "" @State private var password = "" - + var body: some View { VStack { Text("Sign In") @@ -191,7 +191,7 @@ description: Add authentication and user management to your iOS app with Clerk. } extension SignInView { - + func submit(email: String, password: String) async { do { try await SignIn.create( @@ -201,7 +201,7 @@ description: Add authentication and user management to your iOS app with Clerk. dump(error) } } - + } ``` @@ -214,7 +214,7 @@ description: Add authentication and user management to your iOS app with Clerk. struct SignUpOrSignInView: View { @State private var isSignUp = true - + var body: some View { ScrollView { if isSignUp { @@ -222,7 +222,7 @@ description: Add authentication and user management to your iOS app with Clerk. } else { SignInView() } - + Button { isSignUp.toggle() } label: { @@ -248,7 +248,7 @@ description: Add authentication and user management to your iOS app with Clerk. struct ContentView: View { @ObservedObject private var clerk = Clerk.shared - + var body: some View { VStack { if let user = clerk.user { @@ -274,7 +274,7 @@ description: Add authentication and user management to your iOS app with Clerk. struct ContentView: View { @ObservedObject private var clerk = Clerk.shared - + var body: some View { VStack { if let user = clerk.user { diff --git a/docs/quickstarts/javascript.mdx b/docs/quickstarts/javascript.mdx index e38f1e3770..23eb217cbb 100644 --- a/docs/quickstarts/javascript.mdx +++ b/docs/quickstarts/javascript.mdx @@ -40,7 +40,7 @@ Use the following tabs to choose your preferred method. To install Clerk's JavaScript SDK, you need to use a bundler like [Vite](https://vitejs.dev/) or [Webpack](https://webpack.js.org/). - For this tutorial, create a JavaScript app using [Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-project). From the prompts, choose the **Vanilla** framework, and then choose the **JavaScript** variant. + For this tutorial, run the following commands to create a JavaScript app using [Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-project). From the prompts, choose the **Vanilla** framework, and then choose the **JavaScript** variant. ```bash {{ filename: 'terminal' }} @@ -67,7 +67,7 @@ Use the following tabs to choose your preferred method. ### Install `@clerk/clerk-js` - Add the JavaScript SDK to your project by running the following command: + Run the following command to add the JavaScript SDK to your project: ```bash {{ filename: 'terminal' }} diff --git a/docs/quickstarts/nextjs.mdx b/docs/quickstarts/nextjs.mdx index c029036cae..b9c1fc8f7c 100644 --- a/docs/quickstarts/nextjs.mdx +++ b/docs/quickstarts/nextjs.mdx @@ -29,7 +29,7 @@ description: Add authentication and user management to your Next.js app with Cle Clerk's [Next.js SDK](/docs/references/nextjs/overview) gives you access to prebuilt components, React hooks, and helpers to make user authentication easier. - Add the SDK to your project by running the following command: + Run the following command to install the SDK: ```bash {{ filename: 'terminal' }} diff --git a/docs/quickstarts/react.mdx b/docs/quickstarts/react.mdx index 8be3c8f0ef..c2eaa6e5bf 100644 --- a/docs/quickstarts/react.mdx +++ b/docs/quickstarts/react.mdx @@ -30,7 +30,7 @@ description: Add authentication and user management to your React app with Clerk ### Create a React app using Vite - Create a new React app using [Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-project) by running the following command: + Run the following commands to create a new React app using [Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-project): ```bash {{ filename: 'terminal' }} @@ -59,7 +59,7 @@ description: Add authentication and user management to your React app with Clerk Clerk's [React SDK](/docs/references/react/overview) gives you access to prebuilt components, hooks, and helpers to make user authentication easier. - Add the SDK to your project by running the following command: + Run the following command to install the SDK: ```bash {{ filename: 'terminal' }} diff --git a/docs/quickstarts/remix.mdx b/docs/quickstarts/remix.mdx index e23a5f18d9..ec08d052c9 100644 --- a/docs/quickstarts/remix.mdx +++ b/docs/quickstarts/remix.mdx @@ -42,7 +42,7 @@ Learn how to use Clerk to quickly and easily add secure authentication and user Clerk's Remix SDK gives you access to prebuilt components, hooks, and helpers to make user authentication easier. - Add the SDK to your project by running the following command: + Run the following command to install the SDK: ```bash {{ filename: 'terminal' }} diff --git a/docs/quickstarts/tanstack-start.mdx b/docs/quickstarts/tanstack-start.mdx index ee47f933d9..e63f471388 100644 --- a/docs/quickstarts/tanstack-start.mdx +++ b/docs/quickstarts/tanstack-start.mdx @@ -35,7 +35,7 @@ description: Learn how to use Clerk to quickly and easily add secure authenticat Clerk's [TanStack Start SDK](/docs/references/tanstack-start/overview) gives you access to prebuilt components, React hooks, and helpers to make user authentication easier. - Add the SDK to your project by running the following command: + Run the following command to install the SDK: ```bash {{ filename: 'terminal' }} diff --git a/docs/references/javascript/types/overview.mdx b/docs/references/javascript/types/overview.mdx index 4089add735..6bb3ae5b89 100644 --- a/docs/references/javascript/types/overview.mdx +++ b/docs/references/javascript/types/overview.mdx @@ -5,7 +5,7 @@ description: Explore the different types available for typing your application. Types are a powerful tool for adding type-safety to your application. They can help you catch bugs early, make your code easier to understand, and make your code easier to refactor. Clerk provides a number of types to help you add type-safety to your application. -To get access to Clerk types, you need to add the `@clerk/types` package to your project. Install it by running the following command in your terminal: +To get access to Clerk types, you need to add the `@clerk/types` package to your project. Run the following command to install it: ```bash {{ filename: 'terminal' }} diff --git a/docs/references/react/overview.mdx b/docs/references/react/overview.mdx index 6e14f6f9f6..bea8f589fb 100644 --- a/docs/references/react/overview.mdx +++ b/docs/references/react/overview.mdx @@ -3,17 +3,17 @@ title: Clerk React SDK description: Learn how to integrate React into your Clerk application. --- -Clerk React is a wrapper around ClerkJS. It is the recommended way to integrate Clerk into your React application. +The Clerk React SDK is a wrapper around the Clerk JavaScript SDK. It is the recommended way to integrate Clerk into your React application. > [!WARNING] -> If you are using Next.js, please make sure to install `@clerk/nextjs` as `@clerk/clerk-react` is incompatible. See the [Next.js](/docs/references/nextjs/overview) documentation for more information. +> If you are using Next.js, install the `@clerk/nextjs` package, as `@clerk/clerk-react` is incompatible. See the [Next.js](/docs/references/nextjs/overview) documentation for more information. Clerk React provides React.js implementations of [Clerk components](/docs/components/overview); highly customizable, prebuilt components that you can use to build beautiful user management applications. You can find display components for building [sign-in](/docs/components/authentication/sign-in), [sign-up](/docs/components/authentication/sign-up), [account switching](/docs/components/user/user-button), and [user profile management](/docs/components/user/user-profile) pages as well as flow [control components](/docs/components/control/signed-in) that act as helpers for implementing a seamless authentication experience. -Clerk React comes loaded with [custom hooks](/docs/references/react/use-user). These hooks give you access to the [Clerk object](/docs/references/javascript/clerk/clerk), and a set of useful helper methods for signing in and signing up. +Clerk React provides a suite of [custom hooks](/docs/references/react/use-user). These hooks give you access to the [`Clerk` object](/docs/references/javascript/clerk/clerk), and a set of useful helper methods for signing in and signing up. ## Setting up Clerk React -You need to create a Clerk application in your Clerk Dashboard before you can set up Clerk React. For more information, check out the [Set up your application](/docs/quickstarts/setup-clerk) guide. +You need to create a Clerk application in your Clerk Dashboard before you can set up Clerk React. For more information, check out [the dedicated guide.](/docs/quickstarts/setup-clerk) -Once a Clerk application has been created, you can install and then start using Clerk React in your application. The [quickstart guide](/docs/quickstarts/react) will have all the information you need to get started. +Once a Clerk application has been created, you can install and start using Clerk React in your application. [The quickstart guide](/docs/quickstarts/react) will have all the information you need to get started. diff --git a/docs/testing/cypress.mdx b/docs/testing/cypress.mdx index 3fdc6fde8b..b7c5c87f36 100644 --- a/docs/testing/cypress.mdx +++ b/docs/testing/cypress.mdx @@ -16,7 +16,7 @@ This guide aims to help you set up your environment for creating Clerk-authentic ### Install `@clerk/testing` - Clerk's testing package provides integration helpers for popular testing frameworks. Install it by running the following command: + Clerk's testing package provides integration helpers for popular testing frameworks. Run the following command to install it: ```sh {{ filename: 'terminal' }} diff --git a/docs/testing/playwright/overview.mdx b/docs/testing/playwright/overview.mdx index e65125b8ab..085fc4a7d4 100644 --- a/docs/testing/playwright/overview.mdx +++ b/docs/testing/playwright/overview.mdx @@ -11,7 +11,7 @@ description: Use Playwright to write end-to-end tests with Clerk. ### Install `@clerk/testing` - Clerk's testing package provides integration helpers for popular testing frameworks. Install it by running the following command: + Clerk's testing package provides integration helpers for popular testing frameworks. Run the following command to install it: ```sh {{ filename: 'terminal' }} diff --git a/docs/upgrade-guides/expo-v2/upgrade.mdx b/docs/upgrade-guides/expo-v2/upgrade.mdx index f00a2c1b96..16d5bb9c09 100644 --- a/docs/upgrade-guides/expo-v2/upgrade.mdx +++ b/docs/upgrade-guides/expo-v2/upgrade.mdx @@ -20,7 +20,7 @@ The minimum required React Native version is `0.73.0`, and as the SDK is built o ### Update Clerk Expo SDK - Update the Clerk Expo SDK to the latest version by running the following command: + Run the following command to update the Clerk Expo SDK to the latest version: ```bash {{ filename: 'terminal' }} diff --git a/docs/upgrade-guides/node-to-express.mdx b/docs/upgrade-guides/node-to-express.mdx index bbef6bb5f0..3f41a19fcb 100644 --- a/docs/upgrade-guides/node-to-express.mdx +++ b/docs/upgrade-guides/node-to-express.mdx @@ -6,7 +6,7 @@ description: Learn how to upgrade from the Clerk's Node SDK to the Express SDK. ## Install the Express SDK -To upgrade from the Clerk Node SDK to the Clerk Express SDK, uninstall the Node SDK by running the following command: +To upgrade from the Clerk Node SDK to the Clerk Express SDK, run the following command to uninstall the Node SDK: ```sh {{ filename: 'terminal' }} @@ -22,7 +22,7 @@ To upgrade from the Clerk Node SDK to the Clerk Express SDK, uninstall the Node ``` -Then, install the Express SDK by running the following command: +Then, run the following command to install the Express SDK: ```sh {{ filename: 'terminal' }}