Skip to content

Commit ab88e6c

Browse files
authored
Edit sidenav (including reorganizing backend requests) (#2056)
1 parent ae93a05 commit ab88e6c

File tree

102 files changed

+711
-1178
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+711
-1178
lines changed

docs/_partials/authentication/social-connections/test-your-connection.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
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.
1+
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.
22

33
1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/last-active?path=account-portal) page.
44
1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble:

docs/_partials/clerk-middleware-options.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
3939
- `jwtKey`
4040
- `string`
4141

42-
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).
42+
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/manual-jwt).
4343

4444
---
4545

@@ -60,14 +60,14 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
6060
- `signInUrl`
6161
- `string`
6262

63-
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.
63+
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.
6464

6565
---
6666

6767
- `signUpUrl`
6868
- `string`
6969

70-
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.
70+
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.
7171

7272
---
7373

docs/_partials/clerk-options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- `jwtKey?`
1010
- `string`
1111

12-
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).
12+
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/manual-jwt).
1313

1414
---
1515

docs/_partials/clerk-provider/properties.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,9 @@
221221
- `waitlistUrl`
222222
- `string`
223223

224-
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).
224+
The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/account-portal/overview#waitlist).
225225
</Properties>
226226

227227
[components-ref]: /docs/components/overview
228228

229-
[ap-ref]: /docs/customization/account-portal/overview
229+
[ap-ref]: /docs/account-portal/overview
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
> [!WARNING]
2-
> 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).
2+
> 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).
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<Tabs items={["General", "Next.js"]}>
2+
<Tab>
3+
| Variable | Description | Example |
4+
| - | - | - |
5+
| `CLERK_SIGN_IN_URL` | 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.** | `/sign-in` |
6+
| `CLERK_SIGN_UP_URL` | 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.** | `/sign-up` |
7+
| `CLERK_SIGN_IN_FORCE_REDIRECT_URL` | If provided, this URL will always be redirected to after the user signs in. | `/dashboard` |
8+
| `CLERK_SIGN_UP_FORCE_REDIRECT_URL` | If provided, this URL will always be redirected to after the user signs up. | `/dashboard` |
9+
| `CLERK_SIGN_IN_FALLBACK_REDIRECT_URL` | The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. Defaults to `/`. | `/dashboard` |
10+
| `CLERK_SIGN_UP_FALLBACK_REDIRECT_URL` | The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. Defaults to `/`. | `/dashboard` |
11+
</Tab>
12+
13+
<Tab>
14+
| Variable | Description | Example |
15+
| - | - | - |
16+
| `NEXT_PUBLIC_CLERK_SIGN_IN_URL` | 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.** | `/sign-in` |
17+
| `NEXT_PUBLIC_CLERK_SIGN_UP_URL` | 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.** | `/sign-up` |
18+
| `NEXT_PUBLIC_CLERK_SIGN_IN_FORCE_REDIRECT_URL` | If provided, this URL will always be redirected to after the user signs in. | `/dashboard` |
19+
| `NEXT_PUBLIC_CLERK_SIGN_UP_FORCE_REDIRECT_URL` | If provided, this URL will always be redirected to after the user signs up. | `/dashboard` |
20+
| `NEXT_PUBLIC_CLERK_SIGN_IN_FALLBACK_REDIRECT_URL` | The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. Defaults to `/`. | `/dashboard` |
21+
| `NEXT_PUBLIC_CLERK_SIGN_UP_FALLBACK_REDIRECT_URL` | The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. Defaults to `/`. | `/dashboard` |
22+
</Tab>
23+
</Tabs>

docs/_partials/root-auth-loader.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The `rootAuthLoader()` function accepts an optional object. The following option
3232
- `jwtKey`
3333
- `string`
3434

35-
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#api-and-sdk-configuration) instead.** For more information, refer to [Manual JWT verification](/docs/backend-requests/handling/manual-jwt).
35+
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#api-and-sdk-configuration) instead.** For more information, refer to [Manual JWT verification](/docs/backend-requests/manual-jwt).
3636

3737
---
3838

docs/customization/account-portal/direct-links.mdx renamed to docs/account-portal/direct-links.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Direct links
2+
title: Linking to the Account Portal
33
description: Learn how to share direct links to your Account Portal pages, and how to set up fallback redirects.
44
---
55

@@ -13,7 +13,7 @@ You can use the following format for your direct links:
1313

1414
**Example**
1515

16-
If you use `https://accounts.myapp.com/sign-in?redirect_url=https://myapp.com/dashboard`
16+
`https://accounts.myapp.com/sign-in?redirect_url=https://myapp.com/dashboard`
1717

1818
The domain is `myapp.com`, the user is being linked to the sign-in Account Portal page at `http://accounts.myapp.com/sign-in` and they will be redirected to `https://myapp.com/dashboard` after they are signed in.
1919

docs/customization/account-portal/disable-account-portal.mdx renamed to docs/account-portal/disable-account-portal.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ To disable the Account Portal:
1212
1. Select the **Danger** tab.
1313
1. Select **Disable Account Portal**. You will not be able to select this button until you have [set up an authentication flow for your users](#customizing-your-sign-upsign-in-flow), as applying this setting will immediately result in a 404 for all Account Portal pages.
1414

15-
## Customizing your sign-up/sign-in flow
15+
## Customize your sign-up/sign-in flow
1616

17-
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 the Clerk API](/docs/custom-flows/overview).
17+
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. If prebuilt components don't meet your specific needs or if you require more control over the logic, you can rebuild the existing Clerk flows using the Clerk API. See the [custom flows](/docs/custom-flows/overview) guides for more information.

0 commit comments

Comments
 (0)