Merge branch 'main' into vi/docs-9428

clerk · Oct 30, 2024 · 1002973 · 1002973
2 parents b25bc2e + 06f2245
commit 1002973
Show file tree

Hide file tree

Showing 25 changed files with 32 additions and 32 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -580,7 +580,7 @@ The `<Cards>` component can be used to display a grid of cards in various styles
 ---
 
 - [UI Components](/docs/components/overview)
-- Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes.
+- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes.
 
 </Cards>
 ```
@@ -602,7 +602,7 @@ The `<Cards>` component can be used to display a grid of cards in various styles
 ---
 
 - [UI Components](/docs/components/overview)
-- Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes.
+- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes.
 - {<svg viewBox="0 0 32 32">{/*  */}</svg>}
 
 </Cards>
@@ -625,7 +625,7 @@ The `<Cards>` component can be used to display a grid of cards in various styles
 ---
 
 - [UI Components](/docs/components/overview)
-- Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes.
+- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes.
 - {<svg viewBox="0 0 32 32">{/*  */}</svg>}
 
 </Cards>

diff --git a/docs/authentication/configuration/email-sms-templates.mdx b/docs/authentication/configuration/email-sms-templates.mdx
@@ -60,7 +60,7 @@ The following operations are available for an email template:
 
 The following settings can be changed per email template:
 
-- **Delivered by Clerk**: out of the box, Clerk will deliver your emails using its own Email Service Provider (ESP), which is currently [SendGrid](https://sendgrid.com/). However, if you wish to handle delivery of emails on your own, then you can toggle this setting off. This means that Clerk will no longer be sending this particular email and in order to deliver it yourself, you will need to listen to the `emails.created` [webhook](/docs/integrations/webhooks/overview) and extract the necessary info from the event payload.
+- **Delivered by Clerk**: Clerk will deliver your emails using its own Email Service Provider (ESP), which is currently [SendGrid](https://sendgrid.com/). However, if you wish to handle delivery of emails on your own, then you can toggle this setting off. This means that Clerk will no longer be sending this particular email and in order to deliver it yourself, you will need to listen to the `emails.created` [webhook](/docs/integrations/webhooks/overview) and extract the necessary info from the event payload.
 - **Name**: a name for the template on the template listing page. It does not affect the outgoing email in any way.
 - **From**: the email address that will be used as the **From** address in the email header. The format is `<local part>@<your-domain>`. You can change the local part to a custom value. If no value is provided, it defaults `noreply`.
 - **Reply-To**: the email address that will be used as the **Reply-To** address in the email header. This is useful if you want to direct replies to a different email address than the one used in the **From** field. The format is `<local part>@<your-domain>`. You can change the local part to a custom value. If no value is provided, the **Reply-To** header will be omitted.
@@ -111,7 +111,7 @@ To access the SMS templates:
 
 ### Delivered by Clerk
 
-Out of the box, Clerk will deliver your SMS messages using its own SMS Gateway. However, if you wish to handle SMS delivery on your own, then you can toggle **Delivered by Clerk** off.
+Clerk will deliver your SMS messages using its own SMS Gateway. However, if you wish to handle SMS delivery on your own, then you can toggle **Delivered by Clerk** off.
 
 This means that Clerk will no longer be sending this particular SMS and in order to deliver it yourself, you will need to listen to the `sms.created` [webhook](/docs/integrations/webhooks/overview) and extract the necessary info from the event payload.
 

diff --git a/docs/authentication/configuration/session-options.mdx b/docs/authentication/configuration/session-options.mdx
@@ -56,7 +56,7 @@ To enable multi-session in your application, you need to configure it in the Cle
 
 There are two main ways to add the multi-session feature to your application:
 
-- Use the [`<UserButton />`](/docs/components/user/user-button) component if you want to use Clerk's pre-built UI.
+- Use the [`<UserButton />`](/docs/components/user/user-button) component if you want to use Clerk's prebuilt UI.
 - [Build a custom flow](/docs/custom-flows/multi-session-applications) if you want to rebuild the existing Clerk flow using the Clerk API.
 
 ## Customize session token

diff --git a/docs/authentication/configuration/sign-up-sign-in-options.mdx b/docs/authentication/configuration/sign-up-sign-in-options.mdx
@@ -41,7 +41,7 @@ Authentication strategies are methods that users can use to sign up and sign in
 
 Clerk offers two kinds of authentication strategies: **password** and **passwordless**.
 
-Choosing the **password** strategy requires users to set a password during the sign up process. Clerk offers out-of-the-box protection against weak and compromised passwords and the only requirement enforced is that the password be a miminum of 8 characters.
+Choosing the **password** strategy requires users to set a password during the sign up process. Passwords are required to be at least 8 characters long, and Clerk offers out-of-the-box protection against weak and compromised passwords.
 
 > [!NOTE]
 > Passwordless authentication remains available to users, even if the password strategy is enabled.

diff --git a/docs/authentication/saml/jit-provisioning.mdx b/docs/authentication/saml/jit-provisioning.mdx
@@ -7,7 +7,7 @@ Just-in-Time (JIT) Provisioning, or automatic account provisioning, is a process
 
 Using JIT Provisioning means your IT department won't have to manually create user accounts for each of the services or apps your employees use to get work done.
 
-Clerk supports JIT account provisioning for all [supported SAML providers](/docs/authentication/saml/overview) out of the box.
+Clerk supports JIT account provisioning for all [supported SAML providers](/docs/authentication/saml/overview).
 
 Check your preferred SAML provider's documentation to enable JIT account provisioning on their side.
 

diff --git a/docs/components/organization/organization-profile.mdx b/docs/components/organization/organization-profile.mdx
@@ -7,7 +7,7 @@ description: Clerks <OrganizationProfile /> component is used to render a beauti
 
 The `<OrganizationProfile />` component is used to render a beautiful, full-featured organization management UI that allows users to manage their organization profile and security settings.
 
-Out of the box, this component's **General** tab displays the organization's information and the **Leave organization** button. Admins will be able to see the **Update profile** button, **Verified domains** section, and **Delete organization** button.
+This component's **General** tab displays the organization's information and the **Leave organization** button. Admins will be able to see the **Update profile** button, **Verified domains** section, and **Delete organization** button.
 
 The **Members** tab shows the organization's members along with their join dates and roles. Admins will have the ability to invite a member, change a member's role, or remove them from the organization. Admins will have tabs within the **Members** tab to view the organization's [invitations](/docs/organizations/overview#organization-invitations) and [requests](/docs/organizations/overview#membership-requests).
 

diff --git a/docs/components/organization/organization-switcher.mdx b/docs/components/organization/organization-switcher.mdx
@@ -7,7 +7,7 @@ description: Clerk's <OrganizationSwitcher /> component is used to enable the ab
 
 The `<OrganizationSwitcher />` component allows a user to switch between their account types - their personal account and their joined organizations. This component is useful for applications that have a multi-tenant architecture, where users can be part of multiple organizations.
 
-Out of the box, this component will show notifications to the user if they have organization [invitations](/docs/organizations/overview#organization-invitations) or [suggestions](/docs/organizations/overview#suggestions). Admins will be able to see notifications for [requests](/docs/organizations/overview#membership-requests) to join an organization.
+This component will show notifications to the user if they have organization [invitations](/docs/organizations/overview#organization-invitations) or [suggestions](/docs/organizations/overview#suggestions). Admins will be able to see notifications for [requests](/docs/organizations/overview#membership-requests) to join an organization.
 
 If you would like to learn how to hide a user's personal account in order to enforce an organization-centric application, see the [dedicated guide.](/docs/guides/force-organizations)
 

diff --git a/docs/customization/account-portal/disable-account-portal.mdx b/docs/customization/account-portal/disable-account-portal.mdx
@@ -15,4 +15,4 @@ To disable the Account Portal:
 
 ## Customizing your sign-up/sign-in flow
 
-If you would like to migrate away from the Account Portal and create your own sign-up/sign-in flow, Clerk provides a set of [pre-built components](/docs/components/overview) that you can use, or you can opt to build [custom flows using Clerk's API](/docs/custom-flows/overview).
+If you would like to migrate away from the Account Portal and create your own sign-up/sign-in flow, Clerk provides a set of [prebuilt components](/docs/components/overview) that you can use, or you can opt to build [custom flows using Clerk's API](/docs/custom-flows/overview).
diff --git a/docs/customization/elements/examples/sign-in.mdx b/docs/customization/elements/examples/sign-in.mdx
@@ -1,6 +1,6 @@
 ---
 title: Sign-in
-description: Examples of pre-built sign-in flows with Clerk Elements.
+description: Examples of prebuilt sign-in flows with Clerk Elements.
 ---
 
 ## Username/password

diff --git a/docs/customization/elements/examples/sign-up.mdx b/docs/customization/elements/examples/sign-up.mdx
@@ -1,6 +1,6 @@
 ---
 title: Sign-up
-description: Examples of pre-built sign-up flows with Clerk Elements.
+description: Examples of prebuilt sign-up flows with Clerk Elements.
 ---
 
 ## Email/password + email verification

diff --git a/docs/customization/overview.mdx b/docs/customization/overview.mdx
@@ -43,9 +43,9 @@ The `appearance` prop accepts the following properties:
   Fine-grained theme overrides. Useful when you want to style specific elements or elements that are under a specific state. For more information, see the [Customize elements of a Clerk component](#customize-elements-of-a-clerk-component) section.
 </Properties>
 
-## Using a pre-built theme
+## Using a prebuilt theme
 
-Clerk offers a set of pre-built themes that can be used to quickly style Clerk components. See the [Themes](/docs/customization/themes) docs for more information.
+Clerk offers a set of prebuilt themes that can be used to quickly style Clerk components. See the [Themes](/docs/customization/themes) docs for more information.
 
 ## Customize the layout
 
@@ -374,8 +374,8 @@ Here are a few resources you can utilize to customize your Clerk components furt
 
   ---
 
-  - [Pre-built themes](/docs/customization/themes)
-  - Explore Clerk's pre-built themes that you can use to quickly style your Clerk components.
+  - [prebuilt themes](/docs/customization/themes)
+  - Explore Clerk's prebuilt themes that you can use to quickly style your Clerk components.
 
   ---
 

diff --git a/docs/customization/themes.mdx b/docs/customization/themes.mdx
@@ -1,9 +1,9 @@
 ---
 title: Themes
-description: Clerk currently offers four pre-built themes for you to customize the overall appearance of your Clerk app.
+description: Clerk currently offers four prebuilt themes for you to customize the overall appearance of your Clerk app.
 ---
 
-Clerk currently offers four pre-built themes:
+Clerk currently offers four prebuilt themes:
 
 - [The default theme](#default-theme)
 - [The "Dark" theme](#dark-theme)

diff --git a/docs/deployments/migrate-overview.mdx b/docs/deployments/migrate-overview.mdx
@@ -29,7 +29,7 @@ Consider that any export of your data will be a snapshot in time. This means tha
 
 #### Active sessions / session management
 
-Another consideration is centered around how you handle session management. While most authentication providers don't provide session management out of the box, Clerk does. This means that when you switch over to using Clerk you'll be changing the system that handles your users' active sessions. This will likely end any currently active sessions initiated by your previous session management service (unless you are able to gracefully handle this somehow within your architecture).
+Another consideration is centered around how you handle session management. While most authentication providers don't provide session management out-of-the-box, Clerk does. This means that when you switch over to using Clerk you'll be changing the system that handles your users' active sessions. This will likely end any currently active sessions initiated by your previous session management service (unless you are able to gracefully handle this somehow within your architecture).
 
 #### Foreign keys
 

diff --git a/docs/guides/architecture-scenarios.mdx b/docs/guides/architecture-scenarios.mdx
@@ -13,7 +13,7 @@ We will share some of the common characteristics of apps in each scenario as wel
 
 ## B2C: Business to Consumer
 
-B2C companies focus on selling products or services directly to consumers. Some popular examples are Netflix, Headspace, and Spotify. Clerk supports the B2C user management model out of the box, with little-to-no configuration.
+B2C companies focus on selling products or services directly to consumers. Some popular examples are Netflix, Headspace, and Spotify. Clerk supports the B2C user management model out-of-the-box, with little-to-no configuration.
 
 In a B2C scenario, applications generally share the following characteristics:
 

diff --git a/docs/guides/authjs-migration.mdx b/docs/guides/authjs-migration.mdx
@@ -114,7 +114,7 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth.
 
   If Clerk's Account Portal pages aren't a good fit your app, you can build a custom sign-in and sign-up UI in one of two ways:
 
-  - use Clerk's [pre-built components](/docs/references/nextjs/custom-signup-signin-pages), such as the [`<SignIn />`](/docs/components/authentication/sign-in) and [`<SignUp />`](/docs/components/authentication/sign-up) components
+  - use Clerk's [prebuilt components](/docs/references/nextjs/custom-signup-signin-pages), such as the [`<SignIn />`](/docs/components/authentication/sign-in) and [`<SignUp />`](/docs/components/authentication/sign-up) components
   - build a [fully custom UI using Clerk's API](/docs/custom-flows/overview), leveraging Clerk's React hooks such as [`useSignIn()`](/docs/references/react/use-sign-in) and [`useSignUp()`](/docs/references/react/use-sign-up)
 
   ### Protect your app

diff --git a/docs/guides/routing.mdx b/docs/guides/routing.mdx
@@ -23,7 +23,7 @@ There are three routing strategies that can be passed:
 - [`hash`](#hash-routing)
 - [`virtual`](#virtual-routing)
 
-Out of the box, Clerk will attempt to select the routing strategy that best integrates with your framework of choice. If for some reason the default routing strategy doesn't work for you, use the information below to pick a strategy that will work for your setup.
+Clerk will attempt to select the routing strategy that best integrates with your framework of choice. If for some reason the default routing strategy doesn't work for you, use the information below to pick a strategy that will work for your setup.
 
 ### `path` routing
 

diff --git a/docs/index.mdx b/docs/index.mdx
@@ -14,7 +14,7 @@ Find all the guides and resources you need to develop with Clerk.
   ---
 
   - [UI Components](/docs/components/overview)
-  - Clerk's pre-built UI components give you a beautiful, fully-functional user management experience in minutes.
+  - Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes.
   - {<svg viewBox="0 0 32 32" fill="none"><path fill="currentColor" fillOpacity=".15" d="M16 31.25 1.962 25.234A2 2 0 0 1 .75 23.395V7.285l14.462-6.197a2 2 0 0 1 1.576 0L31.25 7.286 16 13.896V31.25Z"/><path fill="currentColor" d="m16 31.25-.295.69a.75.75 0 0 0 1.045-.69H16ZM1.962 25.234l-.295.69.295-.69ZM.75 7.286l-.295-.69a.75.75 0 0 0-.455.69h.75Zm30.5 0 .298.688a.75.75 0 0 0-.003-1.378l-.295.69ZM16.788 1.088l-.296.689.296-.69Zm-1.576 0 .296.689-.296-.69Zm1.083 29.473L2.258 24.544l-.591 1.38 14.038 6.015.59-1.378ZM1.5 23.395V7.285H0v16.11h1.5ZM31.545 6.596 17.083.398l-.59 1.379 14.462 6.198.59-1.379ZM14.917.398.455 6.596l.59 1.38 14.463-6.199-.591-1.379ZM.452 7.974l15.25 6.61.596-1.376-15.25-6.61-.596 1.376Zm15.846 6.61 15.25-6.61-.596-1.376-15.25 6.61.596 1.377Zm-1.048-.688V31.25h1.5V13.896h-1.5ZM17.083.399a2.75 2.75 0 0 0-2.166 0l.59 1.379a1.25 1.25 0 0 1 .985 0l.591-1.379ZM2.258 24.544a1.25 1.25 0 0 1-.758-1.149H0c0 1.1.656 2.095 1.667 2.528l.59-1.379Z"/><path stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" strokeWidth="1.5" d="M31.25 7.281v16.11a2 2 0 0 1-1.212 1.838L16 31.246"/></svg>}
 
   ---

diff --git a/docs/organizations/roles-permissions.mdx b/docs/organizations/roles-permissions.mdx
@@ -74,6 +74,6 @@ To learn more about creating custom permissions, see the [Create roles and permi
 ## Next steps
 
 - [Learn how to create roles and permissions in the Clerk Dashboard](/docs/organizations/create-roles-permissions)
-- [Learn how to use roles and permissions to limit the content a user can see with Clerk's pre-built `<Protect>` component](/docs/components/protect)
+- [Learn how to use roles and permissions to limit the content a user can see with Clerk's prebuilt `<Protect>` component](/docs/components/protect)
 - [Learn how to allow and limit access to resources by role and permissions](/docs/organizations/verify-user-permissions)
 - [Learn how to reassign the **Creator** role](/docs/organizations/creator-role)
diff --git a/docs/references/astro/sign-in-store.mdx b/docs/references/astro/sign-in-store.mdx
@@ -65,4 +65,4 @@ The possible values for the `status` property of the `SignIn` resource are liste
 
 ### Create a custom sign-in flow
 
-The `$signInStore` store can also be used to build fully custom sign-in flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signInStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)
+The `$signInStore` store can also be used to build fully custom sign-in flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signInStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)
diff --git a/docs/references/astro/sign-up-store.mdx b/docs/references/astro/sign-up-store.mdx
@@ -65,4 +65,4 @@ The possible values for the `status` property of the `SignUp` resource are liste
 
 ### Create a custom sign-up flow
 
-The `$signUpStore` store can also be used to build fully custom sign-up flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signUpStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)
+The `$signUpStore` store can also be used to build fully custom sign-up flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signUpStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,4 +15,4 @@ To disable the Account Portal:

		## Customizing your sign-up/sign-in flow

		If you would like to migrate away from the Account Portal and create your own sign-up/sign-in flow, Clerk provides a set of [pre-built components](/docs/components/overview) that you can use, or you can opt to build [custom flows using Clerk's API](/docs/custom-flows/overview).
		If you would like to migrate away from the Account Portal and create your own sign-up/sign-in flow, Clerk provides a set of [prebuilt components](/docs/components/overview) that you can use, or you can opt to build [custom flows using Clerk's API](/docs/custom-flows/overview).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -65,4 +65,4 @@ The possible values for the `status` property of the `SignIn` resource are liste

		### Create a custom sign-in flow

		The `$signInStore` store can also be used to build fully custom sign-in flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signInStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)
		The `$signInStore` store can also be used to build fully custom sign-in flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signInStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -65,4 +65,4 @@ The possible values for the `status` property of the `SignUp` resource are liste

		### Create a custom sign-up flow

		The `$signUpStore` store can also be used to build fully custom sign-up flows, if Clerk's pre-built components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signUpStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)
		The `$signUpStore` store can also be used to build fully custom sign-up flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `$signUpStore` store to create custom flows, check out the [custom flow guides.](/docs/custom-flows/overview)