From a13343b37a1c6c9d985c1ff6b68b73ecc4d572b8 Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Thu, 12 Dec 2024 14:56:59 -0500 Subject: [PATCH] (chore) fix format for component references (#1796) Co-authored-by: victoria --- CONTRIBUTING.md | 2 +- docs/advanced-usage/satellite-domains.mdx | 2 +- docs/guides/architecture-scenarios.mdx | 2 +- docs/guides/authjs-migration.mdx | 6 +++--- docs/quickstarts/chrome-extension.mdx | 2 +- docs/quickstarts/expo.mdx | 2 +- docs/quickstarts/nextjs.mdx | 2 +- docs/quickstarts/react.mdx | 2 +- docs/quickstarts/tanstack-start.mdx | 2 +- docs/telemetry.mdx | 2 +- styleguides/STYLEGUIDE.md | 2 +- 11 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b1f6158d2..4136a9f280 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -575,7 +575,7 @@ The `` component is used at the beginning of a tutorial-type con - Install `@clerk/nextjs` - Set up your environment keys to test your app locally -- Add `` to your application +- Add `` to your application - Use Clerk middleware to implement route-specific authentication - Create a header with Clerk components for users to sign in and out diff --git a/docs/advanced-usage/satellite-domains.mdx b/docs/advanced-usage/satellite-domains.mdx index 9a22e430bf..5ffb193f48 100644 --- a/docs/advanced-usage/satellite-domains.mdx +++ b/docs/advanced-usage/satellite-domains.mdx @@ -115,7 +115,7 @@ To access authentication state from a satellite domain, users will be transparen # CLERK_SIGN_UP_URL=http://localhost:3000/sign-up ``` - - You will also need to add the `allowedRedirectOrigins` property to `` on your _primary domain app_ to ensure that the redirect back from primary to satellite domain works correctly. For example: + - You will also need to add the `allowedRedirectOrigins` property to `` on your _primary domain app_ to ensure that the redirect back from primary to satellite domain works correctly. For example: ```tsx {{ filename: 'app/layout.tsx' }} diff --git a/docs/guides/architecture-scenarios.mdx b/docs/guides/architecture-scenarios.mdx index 9ffecf275c..68cb423248 100644 --- a/docs/guides/architecture-scenarios.mdx +++ b/docs/guides/architecture-scenarios.mdx @@ -56,7 +56,7 @@ Clerk offers a number of building blocks to help integrate organizations into yo - The [`` component](/docs/components/organization/organization-switcher) provides a way for your users to select which organization is active. The [`useOrganizationList()` hook](/docs/organizations/custom-organization-switcher) can be used for more control. - The [`useOrganization()` hook](/docs/references/react/use-organization) can be used to fetch the current, active organization. -- The [`` component](/docs/components/protect) enables you to limit who can view certain pages based on their role. Additionally, Clerk exposes a number of helper functions, such as [`auth()`](/docs/references/nextjs/auth), and hooks, such as [`useAuth()`](/docs/references/react/use-auth#how-to-use-the-use-auth-hook), to check the user's authorization throughout your app and API endpoints. +- The [`` component](/docs/components/protect) enables you to limit who can view certain pages based on their role. Additionally, Clerk exposes a number of helper functions, such as [`auth()`](/docs/references/nextjs/auth), and hooks, such as [`useAuth()`](/docs/references/react/use-auth#how-to-use-the-use-auth-hook), to check the user's authorization throughout your app and API endpoints. The organization's ID should be stored in your database alongside each resource so that it can be used to filter and query the resources that should be rendered or returned according to the active organization. diff --git a/docs/guides/authjs-migration.mdx b/docs/guides/authjs-migration.mdx index f08dfd11e0..0ff9014a9e 100644 --- a/docs/guides/authjs-migration.mdx +++ b/docs/guides/authjs-migration.mdx @@ -23,7 +23,7 @@ description: Learn how to migrate an application using Auth.js to use Clerk for > - Install `@clerk/nextjs` - Set environment variables - - Wrap your Next.js app in `` + - Wrap your Next.js app in `` - Set up sign-up and sign-in UI - Protect your app - Read user and session data @@ -67,9 +67,9 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth. CLERK_SECRET_KEY={{secret}} ``` - ### Wrap your Next.js app in `` + ### Wrap your Next.js app in `` - Remove the `` provider from Auth.js and replace it with ``. + Remove the `` provider from Auth.js and replace it with ``. diff --git a/docs/quickstarts/chrome-extension.mdx b/docs/quickstarts/chrome-extension.mdx index 3cb0d1d644..f361d050e4 100644 --- a/docs/quickstarts/chrome-extension.mdx +++ b/docs/quickstarts/chrome-extension.mdx @@ -21,7 +21,7 @@ description: Add authentication and user management to your Chrome Extension wit - Create a new app with Plasmo - Install `@clerk/chrome-extension` - Set your Clerk API keys - - Add `` and Clerk components to your app + - Add `` and Clerk components to your app - Configure your app to use a consistent CRX ID - Build, load, and test your Chrome Extension diff --git a/docs/quickstarts/expo.mdx b/docs/quickstarts/expo.mdx index 572092eba3..c9d126d8cf 100644 --- a/docs/quickstarts/expo.mdx +++ b/docs/quickstarts/expo.mdx @@ -27,7 +27,7 @@ description: Add authentication and user management to your Expo app with Clerk. > - Install `@clerk/expo` - Set your Clerk API keys - - Add `` + - Add `` - Protect specific pages with authentication - Use Clerk hooks to enable users to sign in and out diff --git a/docs/quickstarts/nextjs.mdx b/docs/quickstarts/nextjs.mdx index d7222bc320..7c6a8bcda1 100644 --- a/docs/quickstarts/nextjs.mdx +++ b/docs/quickstarts/nextjs.mdx @@ -21,7 +21,7 @@ description: Add authentication and user management to your Next.js app with Cle - Install `@clerk/nextjs` - Set your Clerk API keys - Add `clerkMiddleware()` - - Add `` and Clerk components + - Add `` and Clerk components diff --git a/docs/quickstarts/react.mdx b/docs/quickstarts/react.mdx index 21ba2e4f7f..a7384e1c8d 100644 --- a/docs/quickstarts/react.mdx +++ b/docs/quickstarts/react.mdx @@ -23,7 +23,7 @@ description: Add authentication and user management to your React app with Clerk - Create a new React app using Vite - Install `@clerk/clerk-react` - Set your Clerk API keys - - Add `` + - Add `` - Create a header with Clerk components for users to sign in and out diff --git a/docs/quickstarts/tanstack-start.mdx b/docs/quickstarts/tanstack-start.mdx index 4363013d83..909bb5bc3e 100644 --- a/docs/quickstarts/tanstack-start.mdx +++ b/docs/quickstarts/tanstack-start.mdx @@ -26,7 +26,7 @@ description: Learn how to use Clerk to quickly and easily add secure authenticat - Install `@clerk/tanstack-start` - Set your Clerk API keys - Add `createClerkHandler()` - - Add `` + - Add `` - Protect your pages diff --git a/docs/telemetry.mdx b/docs/telemetry.mdx index e34347da2b..9e5dfc27ab 100644 --- a/docs/telemetry.mdx +++ b/docs/telemetry.mdx @@ -72,7 +72,7 @@ CLERK_TELEMETRY_DISABLED=1 ### `telemetry` prop -If you are using `@clerk/clerk-react` directly, or using an SDK that doesn't have environment variable support, you can opt out by passing the `telemetry` prop to ``: +If you are using `@clerk/clerk-react` directly, or using an SDK that doesn't have environment variable support, you can opt out by passing the `telemetry` prop to ``: ```tsx diff --git a/styleguides/STYLEGUIDE.md b/styleguides/STYLEGUIDE.md index 4a6de61262..83c03cdbba 100644 --- a/styleguides/STYLEGUIDE.md +++ b/styleguides/STYLEGUIDE.md @@ -397,7 +397,7 @@ Component references should be wrapped in `< />` if they are self closing. Other The last case is incorrect because the `` component will never wrap children, and therefore, should have a self-closing tag. -> Use the `` component. +> Use the `` component. The last case is incorrect because the `` component will always wrap children and will never be self-closing.