From a1ee71d668548bfa6f96bbb8f25a7f4f675c13f7 Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Wed, 8 Jan 2025 15:01:36 -0800 Subject: [PATCH 1/4] docs(react-router): Add callout about compatibility issue --- docs/quickstarts/react-router.mdx | 3 +++ docs/references/react-router/overview.mdx | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/quickstarts/react-router.mdx b/docs/quickstarts/react-router.mdx index 4f171e5652..87e2ed1c29 100644 --- a/docs/quickstarts/react-router.mdx +++ b/docs/quickstarts/react-router.mdx @@ -33,6 +33,9 @@ description: Learn how to use Clerk to quickly and easily add secure authenticat Clerk's [React Router SDK](/docs/references/react-router/overview) provides prebuilt components, hooks, and stores to make it easy to integrate authentication and user management in your React Router app. This guide assumes that you're using [React Router v7 or later](https://api.reactrouter.com/v7). +> [!WARNING] +> Due to an upstream compatibility issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. + ## Install `@clerk/react-router` diff --git a/docs/references/react-router/overview.mdx b/docs/references/react-router/overview.mdx index c7b3b2c883..8ec9ce8061 100644 --- a/docs/references/react-router/overview.mdx +++ b/docs/references/react-router/overview.mdx @@ -4,7 +4,7 @@ description: Learn how to integrate Clerk into your React Router application usi --- > [!WARNING] -> The React Router SDK is currently in beta. +> Due to an upstream compatibility issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. The Clerk React Router SDK is built on top of the [React SDK](/docs/references/react/overview) and is the recommended method for integrating Clerk into your React Router application. From 1517da5253ea2b121d992d19952fa82a5f6b5a2f Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Wed, 8 Jan 2025 15:02:31 -0800 Subject: [PATCH 2/4] clean up text --- docs/quickstarts/react-router.mdx | 2 +- docs/references/react-router/overview.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/quickstarts/react-router.mdx b/docs/quickstarts/react-router.mdx index 87e2ed1c29..01650d1a92 100644 --- a/docs/quickstarts/react-router.mdx +++ b/docs/quickstarts/react-router.mdx @@ -34,7 +34,7 @@ description: Learn how to use Clerk to quickly and easily add secure authenticat Clerk's [React Router SDK](/docs/references/react-router/overview) provides prebuilt components, hooks, and stores to make it easy to integrate authentication and user management in your React Router app. This guide assumes that you're using [React Router v7 or later](https://api.reactrouter.com/v7). > [!WARNING] -> Due to an upstream compatibility issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. +> Due to an upstream issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. ## Install `@clerk/react-router` diff --git a/docs/references/react-router/overview.mdx b/docs/references/react-router/overview.mdx index 8ec9ce8061..2b3a9cfea6 100644 --- a/docs/references/react-router/overview.mdx +++ b/docs/references/react-router/overview.mdx @@ -4,7 +4,7 @@ description: Learn how to integrate Clerk into your React Router application usi --- > [!WARNING] -> Due to an upstream compatibility issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. +> Due to an upstream issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. The Clerk React Router SDK is built on top of the [React SDK](/docs/references/react/overview) and is the recommended method for integrating Clerk into your React Router application. From 02855c0bebba6998caa0d4bc53d6169010977e6d Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Wed, 8 Jan 2025 18:02:41 -0800 Subject: [PATCH 3/4] Update react-router.mdx Co-authored-by: Colin Sidoti <51144033+colinclerk@users.noreply.github.com> --- docs/quickstarts/react-router.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstarts/react-router.mdx b/docs/quickstarts/react-router.mdx index 01650d1a92..7536264e2e 100644 --- a/docs/quickstarts/react-router.mdx +++ b/docs/quickstarts/react-router.mdx @@ -34,7 +34,7 @@ description: Learn how to use Clerk to quickly and easily add secure authenticat Clerk's [React Router SDK](/docs/references/react-router/overview) provides prebuilt components, hooks, and stores to make it easy to integrate authentication and user management in your React Router app. This guide assumes that you're using [React Router v7 or later](https://api.reactrouter.com/v7). > [!WARNING] -> Due to an upstream issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. +> Due to an active [issue with React Router](https://github.com/remix-run/react-router/issues/12475), Clerk and React Router currently requires using Node.js 22.11 or lower. ## Install `@clerk/react-router` From aa9c299642172d07ec11a426c5201eefe0895e6b Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Wed, 8 Jan 2025 18:02:49 -0800 Subject: [PATCH 4/4] Update overview.mdx Co-authored-by: Colin Sidoti <51144033+colinclerk@users.noreply.github.com> --- docs/references/react-router/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/references/react-router/overview.mdx b/docs/references/react-router/overview.mdx index 2b3a9cfea6..f2172fd371 100644 --- a/docs/references/react-router/overview.mdx +++ b/docs/references/react-router/overview.mdx @@ -4,7 +4,7 @@ description: Learn how to integrate Clerk into your React Router application usi --- > [!WARNING] -> Due to an upstream issue with [React Router](https://github.com/remix-run/react-router/issues/12475), you'll need to use Node.js 22.11 or lower until the issue is resolved. +> Due to an active [issue with React Router](https://github.com/remix-run/react-router/issues/12475), Clerk and React Router currently requires using Node.js 22.11 or lower. The Clerk React Router SDK is built on top of the [React SDK](/docs/references/react/overview) and is the recommended method for integrating Clerk into your React Router application.