Merge branch 'main' into stefanos/fraud-379-write-docs-about-the-new-…

…turnstile-appearance-props
clerk · Feb 26, 2025 · cf30f83 · cf30f83
2 parents 0c5dafa + 3a68136
commit cf30f83
Show file tree

Hide file tree

Showing 277 changed files with 6,013 additions and 7,879 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -420,7 +420,7 @@ You can use the following shortcodes within a code block to inject information f
 - `{{fapi_url}}` – Frontend API URL
 
 ````mdx
-```sh {{ filename: '.env.local' }}
+```sh {{ filename: '.env' }}
 NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY={{pub_key}}
 CLERK_SECRET_KEY={{secret}}
 ```
@@ -839,7 +839,7 @@ The `<Include />` component can be used to inject the contents of another MDX fi
 
 ### `<If />`
 
-The `<If />` component is used for conditional rendering. When the conditions are true, it displays its contents. When the conditions are false, it hides its contents. We commonly use this component to conditionally render content based on the **active SDK**. The **active SDK** is the SDK that is selected in the sidebar.
+The `<If />` component is used for conditional rendering. When the conditions are true, it displays its contents. When the conditions are false, it hides its contents. We commonly use this component to conditionally render content based on the **active SDK**. The **active SDK** is the SDK that is selected in the sidenav.
 
 > [!IMPORTANT]
 > This component cannot be used within code blocks.

diff --git a/docs/_partials/authentication/microsoft/create-app.mdx b/docs/_partials/authentication/microsoft/create-app.mdx
@@ -2,7 +2,7 @@
 > If you already have a Microsoft Entra ID app you'd like to connect to Clerk, select your app from the [Microsoft Azure portal](https://portal.azure.com/#home) and skip to [the next step in this tutorial](#get-your-client-id-and-client-secret).
 
 1. On the homepage of the [Microsoft Azure portal](https://portal.azure.com/#home), in the **Azure services** section, select **[Microsoft Entra ID](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview)**.
-1. In the sidebar, open the **Manage** dropdown and select **[App registrations](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps)**.
+1. In the sidenav, open the **Manage** dropdown and select **[App registrations](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps)**.
 1. Select **New Registration**. You'll be redirected to the **Register an application** page.
 1. Complete the form as follows:
    1. Under **Name**, enter your app name.

diff --git a/docs/_partials/authentication/microsoft/enable-openid.mdx b/docs/_partials/authentication/microsoft/enable-openid.mdx
@@ -1,4 +1,4 @@
-1. In the left sidebar, open the **Manage** dropdown and select **Authentication**.
+1. In the left sidenav, open the **Manage** dropdown and select **Authentication**.
 1. In the **Front-channel logout URL** field, paste the **Redirect URI** you copied from the Clerk Dashboard.
 1. Under **Implicit grant and hybrid flows**, check both **Access tokens** and **ID tokens**.
 1. Select **Save** to save the changes.
diff --git a/docs/_partials/authentication/microsoft/get-client-id-secret.mdx b/docs/_partials/authentication/microsoft/get-client-id-secret.mdx
@@ -1,5 +1,5 @@
 1. From your app's **Overview** page, save the **Application (client) ID** somewhere secure.
-1. In the sidebar, select **Certificates & secrets**.
+1. In the sidenav, select **Certificates & secrets**.
 1. Select **New client secret**.
 1. In the modal that opens, enter a description and set an expiration time for your secret.
    > [!WARNING]

diff --git a/docs/_partials/authentication/microsoft/noauth.mdx b/docs/_partials/authentication/microsoft/noauth.mdx
@@ -4,15 +4,15 @@ For further security, Microsoft offers an optional `xms_edov` [claim](https://le
 
 To enable it, you must:
 
-1. In the left sidebar, in the **Manage** dropdown, select **Token configuration**.
+1. In the left sidenav, in the **Manage** dropdown, select **Token configuration**.
 1. Select **Add optional claim**.
 1. For the **Token type**, select **ID**. Then, in the table that opens, enable the `email` and `xms_pdl` claims.
 1. At the bottom of the modal, select **Add**. A new modal will prompt you to turn on the Microsoft Graph email permission. Enable it, then select **Add** to complete the form.
 1. Repeat the previous steps but for **Token type**, select **Access** instead of **ID**. The **Optional claims** list should now show two claims for `email` and two for `xms_pdl`: one each for **ID** and **Access**.
-1. In the left sidebar, in the **Manage** dropdown, select **Manifest**.
+1. In the left sidenav, in the **Manage** dropdown, select **Manifest**.
 1. In the text editor, search for `"acceptMappedClaims"` and set its value from `null` to `true`.
 1. Search for `"optionalClaims"`, where you'll find the `idToken` and `accessToken` arrays. Each array has an object with the name `xms_pdl`. Change the name to `xms_edov`.
 1. At the top of the page, select **Save**.
-1. In the left sidebar, in the **Manage** dropdown, select **Token configuration** to confirm that the **Optional claims** list includes two claims for `email` and two for `xms_edov`: one each for **ID** and **Access**.
+1. In the left sidenav, in the **Manage** dropdown, select **Token configuration** to confirm that the **Optional claims** list includes two claims for `email` and two for `xms_edov`: one each for **ID** and **Access**.
 
 With these steps complete, Microsoft will send the `xms_edov` claim in the token, which Clerk will use to determine whether the email is verified, even when used with Microsoft Entra ID.
diff --git a/docs/_partials/authentication/social-connections/test-your-connection.mdx b/docs/_partials/authentication/social-connections/test-your-connection.mdx
@@ -1,4 +1,4 @@
-The simplest way to test your connection is to visit your Clerk app's [Account Portal](/docs/customization/account-portal/overview), which is available for all Clerk apps out-of-the-box.
+The simplest way to test your connection is to visit your Clerk app's [Account Portal](/docs/account-portal/overview), which is available for all Clerk apps out-of-the-box.
 
 1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/last-active?path=account-portal) page.
 1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble:

diff --git a/docs/_partials/clerk-middleware-options.mdx b/docs/_partials/clerk-middleware-options.mdx
@@ -39,7 +39,7 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
   - `jwtKey`
   - `string`
 
-  Used to verify the session token in a networkless manner. Supply the PEM public key from the **[**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page -> Show JWT public key -> PEM Public Key** section in the Clerk Dashboard. **It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables) instead.** For more information, refer to [Manual JWT verification](/docs/backend-requests/handling/manual-jwt).
+  Used to verify the session token in a networkless manner. Supply the **JWKS Public Key** from the [**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page in the Clerk Dashboard. **It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables) instead.** For more information, refer to [Manual JWT verification](/docs/backend-requests/manual-jwt).
 
   ---
 
@@ -60,14 +60,14 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
   - `signInUrl`
   - `string`
 
-  This URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances. **It is required to be set for a satellite application in a development instance.** It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+  The full URL or path to your sign-in page. Needs to point to your primary application on the client-side. **Required for a satellite application in a development instance.** It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
 
   ---
 
   - `signUpUrl`
   - `string`
 
-  This URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances but **must be set for a satellite application in a development instance.** It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+  The full URL or path to your sign-up page. Needs to point to your primary application on the client-side. **Required for a satellite application in a development instance.** It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
 
   ---
 

diff --git a/docs/_partials/clerk-options.mdx b/docs/_partials/clerk-options.mdx
@@ -9,7 +9,7 @@
   - `jwtKey?`
   - `string`
 
-  The PEM public key from the **[**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page -> Show JWT public key -> PEM Public Key** section in the Clerk Dashboard. For more information, refer to [Manual JWT verification](/docs/backend-requests/handling/manual-jwt).
+  The **JWKS Public Key** from the [**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) in the Clerk Dashboard. For more information, refer to [Manual JWT verification](/docs/backend-requests/manual-jwt).
 
   ---
 

diff --git a/docs/_partials/clerk-provider/properties.mdx b/docs/_partials/clerk-provider/properties.mdx
@@ -221,9 +221,9 @@
   - `waitlistUrl`
   - `string`
 
-  The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/customization/account-portal/overview#waitlist).
+  The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/account-portal/overview#waitlist).
 </Properties>
 
 [components-ref]: /docs/components/overview
 
-[ap-ref]: /docs/customization/account-portal/overview
+[ap-ref]: /docs/account-portal/overview
diff --git a/docs/_partials/community-sdks.mdx b/docs/_partials/community-sdks.mdx
@@ -62,7 +62,7 @@
 
   ---
 
-  - [Rust](https://github.com/cincinnati-ventures/clerk-rs)
+  - [Rust](https://github.com/DarrenBaldwin07/clerk-rs)
   - Visit the community-maintained Rust SDK to integrate Clerk with Rust.
   - {<svg xmlns="http://www.w3.org/2000/svg" width="76" height="76" viewBox="0 0 76 76" fill="none"><path d="M36.4141 11.8743C36.4141 10.5627 37.4774 9.49935 38.7891 9.49935C40.1007 9.49935 41.1641 10.5627 41.1641 11.8743C41.1641 13.186 40.1007 14.2493 38.7891 14.2493C37.4774 14.2493 36.4141 13.186 36.4141 11.8743ZM11.0807 30.8743C11.0807 29.5627 12.1441 28.4993 13.4557 28.4993C14.7674 28.4993 15.8307 29.5627 15.8307 30.8743C15.8307 32.186 14.7674 33.2493 13.4557 33.2493C12.1441 33.2493 11.0807 32.186 11.0807 30.8743ZM60.1641 30.8743C60.1641 29.5627 61.2274 28.4993 62.5391 28.4993C63.8507 28.4993 64.9141 29.5627 64.9141 30.8743C64.9141 32.186 63.8507 33.2493 62.5391 33.2493C61.2274 33.2493 60.1641 32.186 60.1641 30.8743ZM17.0799 33.3886C17.9926 32.9362 18.4049 31.742 17.9996 30.721L17.1194 28.4993H20.5807V45.916H13.5975C12.7355 42.5361 12.467 39.002 12.8067 35.5083L17.0799 33.3886ZM33.2474 33.2493V28.4993H42.5289C43.0083 28.4993 45.9141 29.0076 45.9141 31.0006C45.9141 32.6554 43.6853 33.2487 41.8526 33.2487L33.2474 33.2493ZM20.5807 59.3743C20.5807 58.0627 21.6441 56.9993 22.9557 56.9993C24.2674 56.9993 25.3307 58.0627 25.3307 59.3743C25.3307 60.686 24.2674 61.7493 22.9557 61.7493C21.6441 61.7493 20.5807 60.686 20.5807 59.3743ZM50.6641 59.3743C50.6641 58.0627 51.7274 56.9993 53.0391 56.9993C54.3507 56.9993 55.4141 58.0627 55.4141 59.3743C55.4141 60.686 54.3507 61.7493 53.0391 61.7493C51.7274 61.7493 50.6641 60.686 50.6641 59.3743ZM51.8225 54.4489C50.7998 54.2224 49.7937 54.8948 49.5746 55.9537L48.5325 60.9793C41.7511 64.1536 33.9674 64.1151 27.2158 60.8736L26.1744 55.8481C25.9552 54.7906 24.9492 54.1168 23.9272 54.3439L19.6339 55.2965C18.8362 54.4476 18.0946 53.5443 17.4141 52.5926H38.3041C38.5405 52.5926 38.6982 52.5484 38.6982 52.3261V44.6896C38.6982 44.4674 38.5405 44.4232 38.3041 44.4232H32.1946V39.5827H38.8025C39.4057 39.5827 42.0276 39.7608 42.866 43.2241C43.1285 44.2893 43.705 47.754 44.0992 48.8633C44.4919 50.1073 46.0911 52.5924 47.7953 52.5924H58.5807C57.8574 53.5929 57.0662 54.5392 56.2133 55.4241L51.8225 54.4489ZM63.206 35.9273C63.3518 37.4459 63.3698 38.9749 63.2598 40.4968H60.6532C60.3923 40.4968 60.2874 40.6742 60.2874 40.9391V42.1793C60.2874 45.0986 58.6985 45.7335 57.3062 45.8952C55.9804 46.0499 54.5104 45.3201 54.3291 44.4795C53.547 39.9217 52.2437 38.9484 50.1855 37.2664C52.7397 35.5859 55.3975 33.1069 55.3975 29.7885C55.3975 26.2054 53.0265 23.9485 51.4105 22.8419C49.1431 21.2935 46.6327 20.9833 45.9555 20.9833H18.9974C22.7241 16.6687 27.7199 13.7475 33.2111 12.6722L36.3888 16.126C37.1072 16.9053 38.297 16.9342 39.0486 16.1893L42.604 12.666C49.9395 14.0897 56.2998 18.7829 59.9964 25.4997L57.5624 31.1953C57.1421 32.1809 57.571 33.3338 58.5198 33.7706L63.206 35.9273ZM69.4589 35.3325L69.3756 34.4797L71.8913 32.1332C72.4029 31.6562 72.2117 30.6961 71.5575 30.4523L68.3415 29.2497L68.0897 28.4195L70.0957 25.6333C70.5048 25.067 70.129 24.1629 69.4401 24.0496L66.049 23.498L65.6412 22.7365L67.0663 19.6085C67.3581 18.9715 66.8158 18.1567 66.1149 18.1834L62.6732 18.3033L62.1295 17.6438L62.9204 14.2912C63.0803 13.6103 62.3894 12.9188 61.7085 13.0787L58.3567 13.8688L57.6958 13.3252L57.8164 9.88336C57.8431 9.18647 57.0276 8.64214 56.392 8.93128L53.2646 10.3571L52.5031 9.94865L51.9502 6.5568C51.8382 5.86926 50.9335 5.49349 50.3672 5.90124L47.579 7.90727L46.7502 7.65609L45.5476 4.43948C45.3038 3.78393 44.3431 3.59537 43.8674 4.10436L41.5209 6.6221L40.6681 6.53882L38.856 3.61072C38.4895 3.01778 37.5082 3.01778 37.1431 3.61072L35.3309 6.53882L34.4774 6.6221L32.1303 4.10436C31.6546 3.59536 30.6939 3.7839 30.4501 4.43948L29.2475 7.65609L28.4181 7.90727L25.6305 5.90124C25.0642 5.49217 24.1588 5.86926 24.0468 6.5568L23.4939 9.94865L22.7324 10.3571L19.605 8.93128C18.9694 8.6408 18.154 9.18645 18.1806 9.88336L18.3005 13.3252L17.6396 13.8688L14.2878 13.0787C13.6069 12.9201 12.9154 13.6103 13.0753 14.2912L13.8648 17.6438L13.3225 18.3033L9.88069 18.1834C9.18648 18.1634 8.63948 18.9716 8.92862 19.6085L10.3544 22.7365L9.94598 23.498L6.55485 24.0496C5.86599 24.1615 5.49289 25.067 5.8993 25.6333L7.90531 28.4195L7.65348 29.2497L4.43689 30.4523C3.78396 30.6961 3.59279 31.6561 4.10311 32.1332L6.61949 34.4797L6.5362 35.3325L3.60876 37.1447C3.01583 37.5111 3.01583 38.4925 3.60876 38.8576L6.5362 40.6698L6.61949 41.5226L4.10311 43.8697C3.59277 44.3454 3.78398 45.3048 4.43689 45.55L7.65348 46.7525L7.90531 47.5827L5.8993 50.3696C5.49156 50.9372 5.86666 51.842 6.55555 51.9525L9.94603 52.5042L10.3544 53.267L8.92868 56.3937C8.6382 57.0293 9.18651 57.8468 9.88075 57.8188L13.3212 57.6982L13.8648 58.3591L13.0753 61.7123C12.9154 62.3918 13.607 63.082 14.2879 62.9221L17.6397 62.1326L18.3006 62.6749L18.1807 66.1174C18.154 66.8143 18.9695 67.3593 19.6051 67.0688L22.7324 65.6438L23.4939 66.0522L24.0469 69.442C24.1588 70.1322 25.0642 70.5053 25.6306 70.0989L28.4168 68.0916L29.2469 68.3441L30.4495 71.5593C30.6933 72.2123 31.654 72.4048 32.1297 71.8931L34.4768 69.3767L35.3303 69.462L37.1425 72.3895C37.5076 72.9797 38.4889 72.9811 38.8554 72.3895L40.6676 69.462L41.5203 69.3767L43.8668 71.8931C44.3425 72.4048 45.3032 72.2122 45.5471 71.5593L46.7496 68.3441L47.5798 68.0916L50.3666 70.0989C50.9329 70.5053 51.8377 70.131 51.9496 69.442L52.5026 66.0522L53.264 65.6438L56.3914 67.0688C57.027 67.3593 57.8411 66.8156 57.8158 66.1174L57.6959 62.6749L58.3561 62.1326L61.7079 62.9221C62.3888 63.082 63.0797 62.3918 62.9199 61.7123L62.1303 58.3591L62.6727 57.6982L66.1144 57.8188C66.8086 57.8468 67.3576 57.0292 67.0658 56.3937L65.6407 53.267L66.0484 52.5042L69.4396 51.9525C70.1298 51.8419 70.5042 50.9372 70.0951 50.3696L68.0891 47.5827L68.3409 46.7525L71.5569 45.55C72.2111 45.3048 72.4023 44.3454 71.8907 43.8697L69.375 41.5226L69.4583 40.6698L72.3857 38.8576C72.9786 38.4925 72.9793 37.5111 72.3862 37.1447L69.4589 35.3325Z" fill="#FF7043"/></svg>}
 </Cards>
diff --git a/docs/_partials/custom-flows-callout.mdx b/docs/_partials/custom-flows-callout.mdx
@@ -1,2 +1,2 @@
 > [!WARNING]
-> This guide is for users who want to build a _custom_ user interface using the Clerk API. To use a _prebuilt_ UI, use the [Account Portal pages](/docs/customization/account-portal/overview) or [prebuilt components](/docs/components/overview).
+> This guide is for users who want to build a _custom_ user interface using the Clerk API. To use a _prebuilt_ UI, use the [Account Portal pages](/docs/account-portal/overview) or [prebuilt components](/docs/components/overview).