Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
139 commits
Select commit Hold shift + click to select a range
4fd7d1b
bring in kyles scripts
NWylynko Jul 17, 2025
28f40e2
support top level and nested items
NWylynko Jul 17, 2025
b62ccef
add watch script
NWylynko Jul 17, 2025
edeef17
Add mapping generation to build ci
NWylynko Jul 18, 2025
f288985
run migration map checker in gh action
NWylynko Jul 18, 2025
4349075
flip order
NWylynko Jul 18, 2025
c3d5cc2
run on push to test ci
NWylynko Jul 18, 2025
7da6b58
generate the manifest first
NWylynko Jul 18, 2025
d41ab9f
remove watch from tsx cli
NWylynko Jul 18, 2025
be7e558
define flags in this repo instead of clerk/clerk
NWylynko Jul 18, 2025
e8fb05c
Only enable ci on certain file changes
NWylynko Jul 18, 2025
b22f559
disable feature flags
NWylynko Jul 18, 2025
c32a424
fix up tests
NWylynko Jul 18, 2025
7c8f48b
Potential fix for code scanning alert no. 10: Workflow does not conta…
NWylynko Jul 18, 2025
b919b0f
add support for 3rd level dropdown
NWylynko Jul 18, 2025
794d218
Add a readme for new scripts
NWylynko Jul 18, 2025
8797e04
Add dotenv
NWylynko Jul 18, 2025
6d75db8
activate top-level manifest splitting and proposal generation
kylemac Jul 19, 2025
2db149f
add support for icons in proposal.md. add more to proposal
kylemac Jul 19, 2025
15b54b6
revise proposal
kylemac Jul 19, 2025
e832559
proposal checkpoint
kylemac Jul 21, 2025
580f0d0
proposal checkpoint
kylemac Jul 21, 2025
d1c0c09
add sub top-level categories under reference
kylemac Jul 21, 2025
5e5ef6e
update proposal from content tuple
kylemac Jul 23, 2025
a33d50d
progress checkin: mostly mappings
kylemac Jul 23, 2025
fe30e22
triage webhooks section
kylemac Jul 23, 2025
7d67070
update
alexisintech Jul 24, 2025
cc98875
work on the mapping script
NWylynko Jul 25, 2025
7a87a82
Add --fix arg
NWylynko Jul 25, 2025
541bf8a
Add script for much better doc deletion
NWylynko Jul 25, 2025
42d6bcb
wip
NWylynko Jul 25, 2025
b71d39e
don't report handled tasks as unhandled files
NWylynko Jul 28, 2025
96ccc3f
Filter out redundant move tasks where source and destination paths ar…
NWylynko Jul 28, 2025
f8f506a
doc needs consonidation
NWylynko Jul 28, 2025
bf0026e
consolidate
NWylynko Jul 28, 2025
9377180
Merge branch 'main' into ia/docs-team-proposal
NWylynko Jul 28, 2025
c434319
add delete doc script to package.json
alexisintech Jul 28, 2025
5827704
update proposal.md
alexisintech Jul 28, 2025
bd05a97
add hooks to general reference in proposal.md
alexisintech Jul 28, 2025
7ae4daf
Added functionality to identify pages needing creation based on the p…
NWylynko Jul 29, 2025
2f5f2e9
Merge branch 'ia/docs-team-proposal' of github.com:clerk/clerk-docs i…
NWylynko Jul 29, 2025
c3348ad
Remove --fix arg from script
NWylynko Jul 29, 2025
7e05441
Remove temporary fix for files in map-content.ts
NWylynko Jul 29, 2025
d231049
manual fixes
alexisintech Jul 29, 2025
4f48151
update delete-doc script to update links for a deleted path
alexisintech Jul 30, 2025
0ab77c3
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 5, 2025
3f0ec0e
add use-migration-blank-page flag
alexisintech Aug 5, 2025
1bda73f
Add support for arbitrary json in proposal.md
NWylynko Aug 8, 2025
500b336
Add {"collapse": false} to overright default collapse true
NWylynko Aug 8, 2025
87c788b
fix up headings
NWylynko Aug 8, 2025
9bbb93f
add tag as an expected type
alexisintech Aug 9, 2025
51c86a7
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 9, 2025
3d00b81
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 9, 2025
c103b38
IA: Configuring your app (/configure) section (#2453)
alexisintech Aug 9, 2025
a8bd645
fix broken link
alexisintech Aug 9, 2025
9400d54
collapsible headings shouldnt be included in path/href generation
alexisintech Aug 9, 2025
e3eeb89
fix social connections all providers subheading
alexisintech Aug 9, 2025
74e96bf
docs review minor changes
SarahSoutoul Aug 11, 2025
d0549f6
revert 9400d54
alexisintech Aug 11, 2025
e829efa
/configure updates
alexisintech Aug 11, 2025
eac33c7
IA: Customizing Clerk (/customizing-clerk) section (#2454)
alexisintech Aug 11, 2025
18b1898
IA: Users (/users) section (#2455)
alexisintech Aug 11, 2025
4fcfe36
Remove generated manifest validation
NWylynko Aug 11, 2025
3b3a8d5
IA: Securing your app and How Clerk works sections (#2458)
alexisintech Aug 12, 2025
bbbb565
Add watcher for flags.json file changes
NWylynko Aug 12, 2025
b90d128
IA: Hooks and components (#2464)
alexisintech Aug 13, 2025
825a0d7
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 13, 2025
698e41b
Fix unhandled files on proposal-mapping
SarahSoutoul Aug 13, 2025
f87faa4
Add option {"skip": true} to skip a segment from href generation
NWylynko Aug 13, 2025
bd7dfe2
IA: Development (/development) section (#2463)
alexisintech Aug 13, 2025
6aec942
IA: B2B Organizations, Billing, Dashboard sections (#2457)
alexisintech Aug 14, 2025
62a34cd
fix redirects
alexisintech Aug 14, 2025
e0823a6
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 15, 2025
0e9478d
fix broken link
alexisintech Aug 15, 2025
96161c2
move force-mfa
alexisintech Aug 15, 2025
912e4fa
Fix proposal mapping after bringing back force mfa + fix broken link
SarahSoutoul Aug 18, 2025
f925265
updates that got lost from main
alexisintech Aug 18, 2025
3419146
IA: References (#2494)
alexisintech Aug 18, 2025
d9756c8
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 18, 2025
8476eb9
Switch to validating the proposal manifest
NWylynko Aug 18, 2025
8995b38
Fix links in machine auth
SarahSoutoul Aug 18, 2025
c1740ff
Move machine auth under development
SarahSoutoul Aug 18, 2025
dcee2df
Switch manifest.json over to the new generated proposal manifest
NWylynko Aug 18, 2025
9368799
Merge branch 'main' into ia/docs-team-proposal
SarahSoutoul Aug 19, 2025
06b2d79
add remove-sdk-development flag
alexisintech Aug 20, 2025
e971241
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 20, 2025
209df91
Update href for "View all guides" to work with https://github.com/cle…
NWylynko Aug 21, 2025
466a643
IA: Getting Started + moving SDK specific guides (#2512)
alexisintech Aug 21, 2025
ad2f086
handle warnings that are failing build
alexisintech Aug 21, 2025
02a2fe2
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 21, 2025
82a3cdc
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 22, 2025
5e567d8
Merge branch 'main' into ia/docs-team-proposal
SarahSoutoul Aug 22, 2025
9e863e6
Add support to link directly to specific sdk variant of a page
NWylynko Aug 22, 2025
9509ac9
Delete guides overview page
SarahSoutoul Aug 22, 2025
f5b6de8
Remove the check-links linter (deprecated)
NWylynko Aug 22, 2025
6856708
change session tasks name in sidebar
alexisintech Aug 25, 2025
f03e7a2
Change heading to user management
SarahSoutoul Aug 25, 2025
d9ec3f7
references --> reference
alexisintech Aug 25, 2025
4eab2c2
merge 'nick/build-script-scoped-to-scoped-with-typedoc' in to 'ia/doc…
NWylynko Aug 25, 2025
17677ee
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 25, 2025
3ec227a
fix lint errors
alexisintech Aug 25, 2025
2e4e94f
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 25, 2025
8ab135b
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 25, 2025
02551ab
Merge branch 'main' into ia/docs-team-proposal
alexisintech Aug 26, 2025
69fe2e9
add api reference overview
alexisintech Sep 2, 2025
2bd1103
Merge branch 'main' into ia/docs-team-proposal
alexisintech Sep 2, 2025
09e289e
update api reference overview
alexisintech Sep 2, 2025
cd49816
remove check-links from lint workflow
alexisintech Sep 2, 2025
da74a31
fix broken links
alexisintech Sep 2, 2025
2f387af
add demo repos
alexisintech Sep 2, 2025
528675a
IA - Add a section to Core Concepts page (#2547)
SarahSoutoul Sep 4, 2025
f76773a
IA: category rework proposal (#2538)
alexisintech Sep 4, 2025
134b0ce
/docs/references/general/** --> /docs/references/**
alexisintech Sep 4, 2025
c665602
fix misspelling
alexisintech Sep 4, 2025
bba66e5
IA: navbar top level collapsible (#2555)
NWylynko Sep 5, 2025
7bccc35
Fix typos and wrong link
SarahSoutoul Sep 5, 2025
cb5d620
Merge branch 'main' into ia/docs-team-proposal
alexisintech Sep 8, 2025
1f248fc
add sdk specificity to doc variant links
alexisintech Sep 8, 2025
509e427
Docs IA: Add 3 overview pages to bring consistency (#2572)
SarahSoutoul Sep 9, 2025
04cf52c
Merge branch 'main' into ia/docs-team-proposal
SarahSoutoul Sep 9, 2025
d28a08c
IA - Fix link hash checking in build script (#2584)
NWylynko Sep 10, 2025
e72ee65
audit: fix redirects
alexisintech Sep 10, 2025
dfb3e9d
Merge branch 'main' into ia/docs-team-proposal
alexisintech Sep 10, 2025
d5e5c5b
fix links
alexisintech Sep 10, 2025
2ed4340
IA: Roy feedback (#2585)
alexisintech Sep 11, 2025
bb84458
Merge branch 'main' into ia/docs-team-proposal
alexisintech Sep 12, 2025
5981b6e
backend sdk --> js backend sdk
alexisintech Sep 12, 2025
65fe762
react router: replace src/ with app/
alexisintech Sep 12, 2025
91bb42a
leftover backend sdk --> js backend sdk
alexisintech Sep 12, 2025
e19f105
fix links
alexisintech Sep 12, 2025
743c184
Only show the hooks overview for sdks that support react hooks
NWylynko Sep 15, 2025
91cc63b
Docs build script - dist folder improvements (#2601)
NWylynko Sep 15, 2025
dcdc79f
Merge branch 'main' into ia/docs-team-proposal
alexisintech Sep 16, 2025
e199eb0
fix broken links
alexisintech Sep 16, 2025
b0273b4
misc updates based on feedback (#2600)
kylemac Sep 17, 2025
d7520b0
IA: Pull overview content into dedicated pages (#2606)
alexisintech Sep 17, 2025
83e78ee
IA - move /docs/references to /docs/reference (#2607)
NWylynko Sep 17, 2025
d244404
Switch to dynamic redirects
NWylynko Sep 17, 2025
92cb51a
Add dynamic redirect to handle sdk scoped guides
NWylynko Sep 17, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ jobs:
- uses: actions/checkout@v3
- run: npm i
- run: npm run lint:formatting
- run: npm run lint:check-links
- run: npm run lint:check-frontmatter

check_quickstarts:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/migration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
push:
paths:
- 'proposal-mapping.json'
- 'proposal.md'
- 'scripts/migration-assistant/map-content.ts'
- 'docs/**'

Expand All @@ -17,5 +16,4 @@ jobs:
steps:
- uses: actions/checkout@v3
- run: npm i
- run: npm run migration:generate-manifest
- run: npm run migration:map-content
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,4 @@ yarn.lock

/docs/docs
/docs/docs/
public/manifest.proposal.json
/local-clerk-typedoc
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,13 +242,13 @@ To update the SDK selector, the files you need are in `clerk/clerk`:

If the SDK has docs that are internal, i.e. maintained in `clerk-docs`, then follow these instructions. If the SDK has docs that are external, e.g. Python located at `https://github.com/clerk/clerk-sdk-python/blob/main/README.md`, then see the [section on adding an external SDK](#add-an-external-sdk).

To add a new SDK, you'll need the SDK name (e.g. `Next.js`), key (e.g. `nextjs`), and 2 SVG icons: one in color and one in grayscale. These must be converted to JSX syntax, not HTML / standard SVG syntax. You will need these SVG's because we list the Clerk SDK's on [https://clerk.com/docs](https://clerk.com/docs), [https://clerk.com/docs/references/overview](https://clerk.com/docs/references/overview), and if there is a quickstart for it, [https://clerk.com/docs/quickstarts/overview](https://clerk.com/docs/quickstarts/overview).
To add a new SDK, you'll need the SDK name (e.g. `Next.js`), key (e.g. `nextjs`), and 2 SVG icons: one in color and one in grayscale. These must be converted to JSX syntax, not HTML / standard SVG syntax. You will need these SVG's because we list the Clerk SDK's on [https://clerk.com/docs](https://clerk.com/docs), [https://clerk.com/docs/reference/overview](https://clerk.com/docs/reference/overview), and if there is a quickstart for it, [https://clerk.com/docs/quickstarts/overview](https://clerk.com/docs/quickstarts/overview).

In this repo (`clerk/clerk-docs`):

1. In the `manifest.schema.json`, add a reference name in the `icon` enum and add the SDK key to the `sdk` enum.
1. Add the color SVG to the partials icon folder `_partials/icons/`.
1. Add the SDK to `index.mdx`, `references/overview.mdx`, and if there is a quickstart for it, `quickstarts/overview.mdx`.
1. Add the SDK to `index.mdx`, `reference/overview.mdx`, and if there is a quickstart for it, `quickstarts/overview.mdx`.
1. In the `manifest.json`, find the `"title": "Clerk SDK",` object. It should be the first object in the `"navigation"` array. Add the SDK accordingly. For example, it could include files like a quickstart, a references section with an overview and some reference docs, or a guides section with some dedicated guides for that SDK.

Now, the sidenav is set up to render the items for the new SDK you've added, and to link to the routes/doc files that you defined. However, you've got to get the SDK selector working as well:
Expand All @@ -262,13 +262,13 @@ In the `clerk/clerk` repo:

If the SDK has docs that are external, e.g. Python located at `https://github.com/clerk/clerk-sdk-python/blob/main/README.md`, then follow these instructions. If the SDK has docs that are internal, i.e. maintained in `clerk-docs`, then see the [section on adding a new SDK](#add-a-new-sdk).

To add a new SDK, you'll need the SDK name (e.g. `Python`), key (e.g. `python`), and 2 SVG icons: one in color and one in grayscale. These must be converted to JSX syntax, not HTML / standard SVG syntax. You will need these SVG's because we list the Clerk SDK's on [https://clerk.com/docs](https://clerk.com/docs) and [https://clerk.com/docs/references/overview](https://clerk.com/docs/references/overview).
To add a new SDK, you'll need the SDK name (e.g. `Python`), key (e.g. `python`), and 2 SVG icons: one in color and one in grayscale. These must be converted to JSX syntax, not HTML / standard SVG syntax. You will need these SVG's because we list the Clerk SDK's on [https://clerk.com/docs](https://clerk.com/docs) and [https://clerk.com/docs/reference/overview](https://clerk.com/docs/reference/overview).

In this repo (`clerk/clerk-docs`):

1. In the `manifest.schema.json`, add a reference name in the `icon` enum and add the SDK key to the `sdk` enum.
1. Add the color SVG to the partials icon folder `_partials/icons/`.
1. Add the SDK to `index.mdx` and `references/overview.mdx`.
1. Add the SDK to `index.mdx` and `reference/overview.mdx`.

Now, the sidenav is set up to render the items for the new SDK you've added, and to link to the routes/doc files that you defined. However, you've got to get the SDK selector working as well:

Expand Down Expand Up @@ -828,7 +828,7 @@ The `<Cards>` component can be used to display a grid of cards in various styles

---

- [UI Components](/docs/components/overview)
- [UI Components](/docs/reference/components/overview)
- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes.

</Cards>
Expand All @@ -850,7 +850,7 @@ The `<Cards>` component can be used to display a grid of cards in various styles

---

- [UI Components](/docs/components/overview)
- [UI Components](/docs/reference/components/overview)
- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes.
- {<svg viewBox="0 0 32 32">{/* */}</svg>}

Expand All @@ -873,7 +873,7 @@ The `<Cards>` component can be used to display a grid of cards in various styles

---

- [UI Components](/docs/components/overview)
- [UI Components](/docs/reference/components/overview)
- Clerk's prebuilt UI components give you a beautiful, fully-functional user management experience in minutes.
- {<svg viewBox="0 0 32 32">{/* */}</svg>}

Expand All @@ -890,13 +890,13 @@ The `<Cards>` component can be used to display a grid of cards in various styles
```mdx
<Cards variant="image">

- [What is Clerk authentication?](/docs/authentication/overview)
- [What is Clerk authentication?](/docs/guides/configure/auth-strategies/sign-up-sign-in-options)
- Clerk offers multiple authentication strategies to identify legitimate users of your application, and to allow them to make authenticated requests to your backend.
- ![](/what-is-clerk.png)

---

- [What is the “User” object?](/docs/users/overview)
- [What is the “User” object?](/docs/guides/users/managing)
- The User object contains all account information that describes a user of your app in Clerk. Users can authenticate and manage their accounts, update their personal and contact info, or set up security features for their accounts.
- ![](/user-object.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/_partials/astro/auth-store.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The following example demonstrates how to use the [`$authStore`](/docs/references/astro/auth-store) to access the current auth state. It uses `userId` to detect if the user is signed in.
The following example demonstrates how to use the [`$authStore`](/docs/reference/astro/client-side-helpers/auth-store) to access the current auth state. It uses `userId` to detect if the user is signed in.

<CodeBlockTabs options={['React', 'Vue', 'Svelte']}>
```tsx {{ filename: 'components/external-data.tsx' }}
Expand Down
4 changes: 2 additions & 2 deletions docs/_partials/astro/user-store.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The following example demonstrates how to use the [`$userStore`](/docs/references/astro/user-store) to access the `User` object. It returns `undefined` while Clerk is still loading and `null` if the user is not signed in.
The following example demonstrates how to use the [`$userStore`](/docs/reference/astro/client-side-helpers/user-store) to access the `User` object. It returns `undefined` while Clerk is still loading and `null` if the user is not signed in.

For more information, see the [`User` reference](/docs/references/javascript/user){{ target: '_blank' }}.
For more information, see the [`User` reference](/docs/reference/javascript/user){{ target: '_blank' }}.

<CodeBlockTabs options={['React', 'Vue', 'Svelte']}>
```tsx {{ filename: 'user.tsx' }}
Expand Down
14 changes: 7 additions & 7 deletions docs/_partials/auth-object-table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ The `Auth` object is available on the `request` object in server contexts. Some

| Framework | How to access the `Auth` object |
| - | - |
| Next.js App Router | [`auth()`](/docs/references/nextjs/auth) |
| Next.js Pages Router | [`getAuth()`](/docs/references/nextjs/get-auth) |
| Astro | [`locals.auth()`](/docs/references/astro/locals#locals-auth) |
| Express | [`req.auth`](/docs/references/express/overview) |
| React Router | [`getAuth()`](/docs/references/react-router/get-auth) |
| Remix | [`getAuth()`](/docs/references/remix/read-session-data#get-auth) |
| Tanstack React Start | [`getAuth()`](/docs/references/tanstack-react-start/get-auth) |
| Next.js App Router | [`auth()`](/docs/reference/nextjs/app-router/auth) |
| Next.js Pages Router | [`getAuth()`](/docs/reference/nextjs/pages-router/get-auth) |
| Astro | [`locals.auth()`](/docs/reference/astro/locals#locals-auth) |
| Express | [`req.auth`](/docs/reference/express/overview) |
| React Router | [`getAuth()`](/docs/reference/react-router/get-auth) |
| Remix | [`getAuth()`](/docs/reference/remix/overview#get-auth) |
| Tanstack React Start | [`getAuth()`](/docs/reference/tanstack-react-start/get-auth) |
| Other | `request.auth` |
5 changes: 2 additions & 3 deletions docs/_partials/authentication/passkeys-restriction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ Passkeys are tied to the domain they are created on and **cannot be used across
- Passkeys created on `your-domain.com` **can be used** on `accounts.your-domain.com` (subdomain of the same root domain).
- Passkeys created on `staging1.your-domain.com` **cannot be used** on `staging2.your-domain.com` (sibling subdomains) unless the passkey was scoped to `your-domain.com` (i.e. the shared root domain).

**If you're using [satellite domains](/docs/advanced-usage/satellite-domains)**, in both development and production, passkeys won't be portable between your primary domain and your satellite domains so you should avoid using them.
**If you're using [satellite domains](/docs/guides/dashboard/dns-domains/satellite-domains)**, in both development and production, passkeys won't be portable between your primary domain and your satellite domains so you should avoid using them.

If you're **not** using satellite domains:

- **In development**, you can either:

- **The recommended approach**. Use Clerk's [components](/docs/components/overview), [Elements](/docs/customization/elements/overview), or [custom flows](/docs/custom-flows/overview), instead of the [Account Portal](/docs/account-portal/overview). This ensures the passkey is created and used entirely on your development domain, so passkeys created on `localhost` will only work on `localhost`.
- **The recommended approach**. Use Clerk's [components](/docs/reference/components/overview), [Elements](/docs/guides/customizing-clerk/elements/overview), or [custom flows](/docs/guides/development/custom-flows/overview), instead of the [Account Portal](/docs/guides/customizing-clerk/account-portal). This ensures the passkey is created and used entirely on your development domain, so passkeys created on `localhost` will only work on `localhost`.
- Create a passkey directly through the Account Portal instead of your local application to keep it tied to the Account Portal's domain. Passkeys created on your Account Portal (e.g., `your-app.accounts.dev`) will only work on that domain, which can cause issues if you switch between `localhost` and the Account Portal during development. If you choose this approach, ensure all testing happens on the same domain where the passkey was created.

- **In production,** your Account Portal is usually hosted on a subdomain of your main domain (e.g. `accounts.your-domain.com`), enabling passkeys to work seamlessly across your app. However, as stated above, if you use **satellite domains**, passkeys will not work as intended.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
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.
The simplest way to test your connection is to visit your Clerk app's [Account Portal](/docs/guides/customizing-clerk/account-portal), 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 **Sign-in**, select the button to visit the sign-in page. The URL should resemble:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
---
title: Available versions
description: A list of the available API versions and their breaking changes.
---

Below is a list of all the available API versions with their respective breaking changes. For information on how to apply the appropriate version, see [Versioning overview](/docs/versioning/overview).

### 2025-04-10

Adds support for [version 2 of Clerk session tokens](/docs/backend-requests/resources/session-tokens).
Adds support for [version 2 of Clerk session tokens](/docs/guides/sessions/session-tokens).
The following SDKs are compatible with this version:

| SDK | Version |
Expand Down
2 changes: 1 addition & 1 deletion docs/_partials/backend/usage.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
> [!NOTE]
> Importing `clerkClient` varies based on your framework. Refer to the [Backend SDK overview](/docs/references/backend/overview) for usage details, including guidance on [how to access the `userId` and other properties](/docs/references/backend/overview#get-the-user-id-and-other-properties).
> Importing `clerkClient` varies based on your framework. Refer to the [JS Backend SDK overview](/docs/js-backend/getting-started/quickstart) for usage details, including guidance on [how to access the `userId` and other properties](/docs/js-backend/getting-started/quickstart#get-the-user-id-and-other-properties).
8 changes: 4 additions & 4 deletions docs/_partials/clerk-middleware-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
- `jwtKey`
- `string`

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).
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/guides/development/clerk-environment-variables) instead.** For more information, refer to [Manual JWT verification](/docs/guides/sessions/manual-jwt-verification).

---

- `organizationSyncOptions?`
- <code>[OrganizationSyncOptions](#organization-sync-options) | undefined</code>

Used to activate a specific [organization](/docs/organizations/overview) or [personal account](/docs/organizations/overview#allow-personal-accounts) based on URL path parameters. If there's a mismatch between the active organization in the session (e.g., as reported by [`auth()`](/docs/references/nextjs/auth)) and the organization indicated by the URL, the middleware will attempt to activate the organization specified in the URL.
Used to activate a specific [organization](/docs/guides/organizations/overview) or [personal account](/docs/guides/dashboard/overview) based on URL path parameters. If there's a mismatch between the active organization in the session (e.g., as reported by [`auth()`](/docs/reference/nextjs/app-router/auth)) and the organization indicated by the URL, the middleware will attempt to activate the organization specified in the URL.

---

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

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.
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/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.

---

- `signUpUrl`
- `string`

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.
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/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.

---

Expand Down
6 changes: 3 additions & 3 deletions docs/_partials/clerk-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- `jwtKey?`
- `string`

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).
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/guides/sessions/manual-jwt-verification).

---

Expand All @@ -23,7 +23,7 @@
- `domain?`
- `string`

The domain of a [satellite application](/docs/advanced-usage/satellite-domains) in a multi-domain setup.
The domain of a [satellite application](/docs/guides/dashboard/dns-domains/satellite-domains) in a multi-domain setup.

---

Expand Down Expand Up @@ -51,7 +51,7 @@
- `telemetry?`
- `{ disabled: boolean, debug: boolean }`

[Telemetry](/docs/telemetry) configuration.
[Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/_partials/clerk-provider/explanation.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The [`<ClerkProvider>`](/docs/components/clerk-provider) component provides session and user context to Clerk's hooks and components. It's recommended to wrap your entire app at the entry point with `<ClerkProvider>` to make authentication globally accessible. See the [reference docs](/docs/components/clerk-provider) for other configuration options.
The [`<ClerkProvider>`](/docs/reference/components/clerk-provider) component provides session and user context to Clerk's hooks and components. It's recommended to wrap your entire app at the entry point with `<ClerkProvider>` to make authentication globally accessible. See the [reference docs](/docs/reference/components/clerk-provider) for other configuration options.
Loading
Loading