From d7f40155a5f055eab53a13a44fb3110bf2bec755 Mon Sep 17 00:00:00 2001 From: Matt Brophy Date: Thu, 17 Oct 2024 13:26:55 -0400 Subject: [PATCH] docs: update broken RR links (#10130) --- CHANGELOG.md | 6 +++--- docs/file-conventions/vite-config.md | 2 +- docs/guides/migrating-react-router-app.md | 2 +- docs/guides/spa-mode.md | 4 ++-- docs/hooks/use-resolved-path.md | 4 ++-- docs/other-api/testing.md | 2 +- docs/utils/is-route-error-response.md | 2 +- packages/remix-cloudflare/CHANGELOG.md | 8 ++++---- packages/remix-deno/CHANGELOG.md | 8 ++++---- packages/remix-dev/CHANGELOG.md | 2 +- packages/remix-express/CHANGELOG.md | 2 +- packages/remix-node/CHANGELOG.md | 8 ++++---- packages/remix-react/CHANGELOG.md | 20 ++++++++++---------- packages/remix-serve/CHANGELOG.md | 8 ++++---- packages/remix-server-runtime/CHANGELOG.md | 10 +++++----- packages/remix-testing/CHANGELOG.md | 8 ++++---- 16 files changed, 48 insertions(+), 48 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index be263996cc9..95895e03f8c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -965,7 +965,7 @@ You can now export an optional `Layout` component from your root route which wil #### Basename support -React Router has long supported a [`basename`](https://reactrouter.com/en/main/routers/create-browser-router#basename) config that allows you to serve your app within a subpath such as `http://localhost/myapp/*` without having to include the `/myapp` segment in all of your route paths. This was originally omitted from Remix because v1 nested folders file-convention made it pretty easy to put your route files in a `routes/myapp/` folder, giving you the same functionality. There has also been an [open proposal from the community](https://github.com/remix-run/remix/discussions/2891) to add this functionality. +React Router has long supported a [`basename`](https://reactrouter.com/v6/routers/create-browser-router#basename) config that allows you to serve your app within a subpath such as `http://localhost/myapp/*` without having to include the `/myapp` segment in all of your route paths. This was originally omitted from Remix because v1 nested folders file-convention made it pretty easy to put your route files in a `routes/myapp/` folder, giving you the same functionality. There has also been an [open proposal from the community](https://github.com/remix-run/remix/discussions/2891) to add this functionality. Two things have since changed that made us reconsider the lack of `basename` support: @@ -1023,7 +1023,7 @@ A few notes on the new plugin: - This gives parity with the Cloudflare preset for the Remix Vite plugin and keeps our templates leaner - `@remix-run/dev` - Vite: Cloudflare Proxy as a Vite plugin ([#8749](https://github.com/remix-run/remix/pull/8749)) - **⚠️ This is a breaking change for projects relying on Cloudflare support from the unstable Vite plugin** -- `@remix-run/dev` - Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/en/main/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) +- `@remix-run/dev` - Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/v6/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) - `@remix-run/dev` - Vite: Stabilize the Remix Vite plugin, Cloudflare preset, and all related types by removing all `unstable_` / `Unstable_` prefixes ([#8713](https://github.com/remix-run/remix/pull/8713)) - While this is a breaking change for existing Remix Vite plugin consumers, now that the plugin has stabilized, there will no longer be any breaking changes outside of a major release. Thank you to all of our early adopters and community contributors for helping us get here! 🙏 - `@remix-run/dev` - Vite: Stabilize "SPA Mode" by renaming the Remix vite plugin config from `unstable_ssr -> ssr` ([#8692](https://github.com/remix-run/remix/pull/8692)) @@ -1715,7 +1715,7 @@ function handleClick() { ### Minor Changes -- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/en/main/hooks/use-blocker) hook ([#7882](https://github.com/remix-run/remix/pull/7882)) +- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/v6/hooks/use-blocker) hook ([#7882](https://github.com/remix-run/remix/pull/7882)) - Add `unstable_flushSync` option to `useNavigate`/`useSubmit`/`fetcher.load`/`fetcher.submit` to opt-out of `React.startTransition` and into `ReactDOM.flushSync` for state updates ([#7996](https://github.com/remix-run/remix/pull/7996)) ### Patch Changes diff --git a/docs/file-conventions/vite-config.md b/docs/file-conventions/vite-config.md index 67a47c85dd7..4f6ece8ce23 100644 --- a/docs/file-conventions/vite-config.md +++ b/docs/file-conventions/vite-config.md @@ -140,6 +140,6 @@ You may also want to enable the `manifest` option since, when server bundles are [minimatch]: https://npm.im/minimatch [presets]: ../guides/presets [server-bundles]: ../guides/server-bundles -[rr-basename]: https://reactrouter.com/routers/create-browser-router#basename +[rr-basename]: https://reactrouter.com/v6/routers/create-browser-router#basename [vite-public-base-path]: https://vitejs.dev/config/shared-options.html#base [vite-base]: https://vitejs.dev/config/shared-options.html#base diff --git a/docs/guides/migrating-react-router-app.md b/docs/guides/migrating-react-router-app.md index ddca6c31601..6367c259bbb 100644 --- a/docs/guides/migrating-react-router-app.md +++ b/docs/guides/migrating-react-router-app.md @@ -693,7 +693,7 @@ Now then, go off and _remix your app_. We think you'll like what you build along - [Common "gotchas"][common-gotchas] [react-router]: https://reactrouter.com -[react-router-docs]: https://reactrouter.com/start/concepts +[react-router-docs]: https://reactrouter.com/v6/start/concepts [migration-guide-from-v5-to-v6]: https://reactrouter.com/en/6.22.3/upgrading/v5 [backwards-compatibility-package]: https://www.npmjs.com/package/react-router-dom-v5-compat [a-few-tweaks-to-improve-progressive-enhancement]: ../pages/philosophy#progressive-enhancement diff --git a/docs/guides/spa-mode.md b/docs/guides/spa-mode.md index fe7088e63bf..a2d9ca55a98 100644 --- a/docs/guides/spa-mode.md +++ b/docs/guides/spa-mode.md @@ -288,9 +288,9 @@ Once you've got all your routes living in their own files, you can: [fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API [runtimes]: ../discussion/runtimes [kent-tweet]: https://twitter.com/kentcdodds/status/1743030378334708017 -[rr-setup]: https://reactrouter.com/en/main/start/tutorial#setup +[rr-setup]: https://reactrouter.com/v6/start/tutorial#setup [routes-config]: ../file-conventions/remix-config#routes -[route-lazy]: https://reactrouter.com/en/main/route/lazy +[route-lazy]: https://reactrouter.com/v6/route/lazy [meta]: ../components/meta [links]: ../components/links [migrating-rr]: https://remix.run/docs/en/main/guides/migrating-react-router-app diff --git a/docs/hooks/use-resolved-path.md b/docs/hooks/use-resolved-path.md index 51ea63f609a..26fbb86a791 100644 --- a/docs/hooks/use-resolved-path.md +++ b/docs/hooks/use-resolved-path.md @@ -46,6 +46,6 @@ When you enable the flag, this "bug" is fixed so that path resolution is consist - [`resolvePath`][rr-resolve-path] [nav-link-component]: ../components/nav-link -[rr-resolve-path]: https://reactrouter.com/utils/resolve-path -[rr-use-resolved-path-splat]: https://reactrouter.com/hooks/use-resolved-path#splat-paths +[rr-resolve-path]: https://reactrouter.com/v6/utils/resolve-path +[rr-use-resolved-path-splat]: https://reactrouter.com/v6/hooks/use-resolved-path#splat-paths [remix-config-future]: https://remix.run/docs/en/main/file-conventions/remix-config#future diff --git a/docs/other-api/testing.md b/docs/other-api/testing.md index 583ba772ada..9a3dd38bcc9 100644 --- a/docs/other-api/testing.md +++ b/docs/other-api/testing.md @@ -70,7 +70,7 @@ test("renders loader data", async () => { }); ``` -[create-memory-router]: https://reactrouter.com/en/main/routers/create-memory-router +[create-memory-router]: https://reactrouter.com/v6/routers/create-memory-router [use-loader-data]: ../hooks/use-loader-data [use-fetcher]: ../hooks/use-fetcher [cypress]: https://www.cypress.io diff --git a/docs/utils/is-route-error-response.md b/docs/utils/is-route-error-response.md index af40426f3eb..ef610029585 100644 --- a/docs/utils/is-route-error-response.md +++ b/docs/utils/is-route-error-response.md @@ -7,4 +7,4 @@ toc: false This util is simply a re-export of [React Router's `isRouteErrorResponse`][rr-isrouteerrorresponse]. -[rr-isrouteerrorresponse]: https://reactrouter.com/utils/is-route-error-response +[rr-isrouteerrorresponse]: https://reactrouter.com/v6/utils/is-route-error-response diff --git a/packages/remix-cloudflare/CHANGELOG.md b/packages/remix-cloudflare/CHANGELOG.md index d29516e638e..d1b291b492b 100644 --- a/packages/remix-cloudflare/CHANGELOG.md +++ b/packages/remix-cloudflare/CHANGELOG.md @@ -480,10 +480,10 @@ Documentation Resources (better docs specific to Remix are in the works): - - - - - - - - + - + - + - + - - Updated dependencies: - `@remix-run/server-runtime@1.11.0` diff --git a/packages/remix-deno/CHANGELOG.md b/packages/remix-deno/CHANGELOG.md index 58a204b7503..a08d7c3a9fc 100644 --- a/packages/remix-deno/CHANGELOG.md +++ b/packages/remix-deno/CHANGELOG.md @@ -511,10 +511,10 @@ Documentation Resources (better docs specific to Remix are in the works): - - - - - - - - + - + - + - + - - Updated dependencies: - `@remix-run/server-runtime@1.11.0` diff --git a/packages/remix-dev/CHANGELOG.md b/packages/remix-dev/CHANGELOG.md index a113245a8b4..3d950d0a13e 100644 --- a/packages/remix-dev/CHANGELOG.md +++ b/packages/remix-dev/CHANGELOG.md @@ -273,7 +273,7 @@ - Vite: Stabilize "SPA Mode" by renaming the Remix vite plugin config from `unstable_ssr -> ssr` ([#8692](https://github.com/remix-run/remix/pull/8692)) -- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/en/main/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) +- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/v6/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) ### Patch Changes diff --git a/packages/remix-express/CHANGELOG.md b/packages/remix-express/CHANGELOG.md index d18fb63860d..804ec7e9891 100644 --- a/packages/remix-express/CHANGELOG.md +++ b/packages/remix-express/CHANGELOG.md @@ -132,7 +132,7 @@ ### Minor Changes -- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/en/main/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) +- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/v6/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) ### Patch Changes diff --git a/packages/remix-node/CHANGELOG.md b/packages/remix-node/CHANGELOG.md index 839aaa649df..9bf22339225 100644 --- a/packages/remix-node/CHANGELOG.md +++ b/packages/remix-node/CHANGELOG.md @@ -527,10 +527,10 @@ Documentation Resources (better docs specific to Remix are in the works): - - - - - - - - + - + - + - + - - Updated dependencies: - `@remix-run/server-runtime@1.11.0` diff --git a/packages/remix-react/CHANGELOG.md b/packages/remix-react/CHANGELOG.md index 9bdd8186649..b61c313b838 100644 --- a/packages/remix-react/CHANGELOG.md +++ b/packages/remix-react/CHANGELOG.md @@ -279,7 +279,7 @@ ### Minor Changes - Allow an optional `Layout` export from the root route ([#8709](https://github.com/remix-run/remix/pull/8709)) -- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/en/main/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) +- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/v6/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) ### Patch Changes @@ -397,7 +397,7 @@ ### Minor Changes -- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/en/main/hooks/use-blocker) hook as it's been in use for enough time that we are confident in the API. We do not plan to remove the prefix from `unstable_usePrompt` due to differences in how browsers handle `window.confirm` that prevent React Router from guaranteeing consistent/correct behavior. ([#7882](https://github.com/remix-run/remix/pull/7882)) +- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/v6/hooks/use-blocker) hook as it's been in use for enough time that we are confident in the API. We do not plan to remove the prefix from `unstable_usePrompt` due to differences in how browsers handle `window.confirm` that prevent React Router from guaranteeing consistent/correct behavior. ([#7882](https://github.com/remix-run/remix/pull/7882)) ### Patch Changes @@ -979,10 +979,10 @@ No significant changes to this package were made in this release. [See the relea Documentation Resources (better docs specific to Remix are in the works): - - - - - - - - + - + - + - + - ## 1.10.1 @@ -997,10 +997,10 @@ No significant changes to this package were made in this release. [See the relea - Update Remix to use new data APIs introduced in React Router v6.4 ([#4900](https://github.com/remix-run/remix/pull/4900)) - Added new hooks from React Router - - [`useNavigation`](https://reactrouter.com/en/main/hooks/use-navigation) - - [`useNavigationType`](https://reactrouter.com/en/main/hooks/use-navigation-type) - - [`useRevalidator`](https://reactrouter.com/en/main/hooks/use-revalidator) - - [`useRouteLoaderData`](https://reactrouter.com/en/main/hooks/use-route-loader-data) + - [`useNavigation`](https://reactrouter.com/v6/hooks/use-navigation) + - [`useNavigationType`](https://reactrouter.com/v6/hooks/use-navigation-type) + - [`useRevalidator`](https://reactrouter.com/v6/hooks/use-revalidator) + - [`useRouteLoaderData`](https://reactrouter.com/v6/hooks/use-route-loader-data) ## 1.9.0 diff --git a/packages/remix-serve/CHANGELOG.md b/packages/remix-serve/CHANGELOG.md index 1c0d1969f89..8d4ceed2175 100644 --- a/packages/remix-serve/CHANGELOG.md +++ b/packages/remix-serve/CHANGELOG.md @@ -476,10 +476,10 @@ Documentation Resources (better docs specific to Remix are in the works): - - - - - - - - + - + - + - + - - Updated dependencies: - `@remix-run/express@1.11.0` diff --git a/packages/remix-server-runtime/CHANGELOG.md b/packages/remix-server-runtime/CHANGELOG.md index 60d8486e108..b3d46d76d88 100644 --- a/packages/remix-server-runtime/CHANGELOG.md +++ b/packages/remix-server-runtime/CHANGELOG.md @@ -241,7 +241,7 @@ No significant changes to this package were made in this release. [See the repo ### Minor Changes - Allow an optional `Layout` export from the root route ([#8709](https://github.com/remix-run/remix/pull/8709)) -- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/en/main/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) +- Vite: Add a new `basename` option to the Vite plugin, allowing users to set the internal React Router [`basename`](https://reactrouter.com/v6/routers/create-browser-router#basename) in order to to serve their applications underneath a subpath ([#8145](https://github.com/remix-run/remix/pull/8145)) ### Patch Changes @@ -994,10 +994,10 @@ No significant changes to this package were made in this release. [See the relea Documentation Resources (better docs specific to Remix are in the works): - - - - - - - - + - + - + - + - ## 1.10.1 diff --git a/packages/remix-testing/CHANGELOG.md b/packages/remix-testing/CHANGELOG.md index 261d421eec5..663e17d1e56 100644 --- a/packages/remix-testing/CHANGELOG.md +++ b/packages/remix-testing/CHANGELOG.md @@ -536,10 +536,10 @@ Documentation Resources (better docs specific to Remix are in the works): - - - - - - - - + - + - + - + - - Updated dependencies: - `@remix-run/react@1.11.0`