Skip to content

Commit

Permalink
docs: update broken RR links (#10130)
Browse files Browse the repository at this point in the history
  • Loading branch information
brophdawg11 authored Oct 17, 2024
1 parent a4b3829 commit d7f4015
Show file tree
Hide file tree
Showing 16 changed files with 48 additions and 48 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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))
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/file-conventions/vite-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/guides/migrating-react-router-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/spa-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/hooks/use-resolved-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/other-api/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/utils/is-route-error-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ toc: false

<docs-info>This util is simply a re-export of [React Router's `isRouteErrorResponse`][rr-isrouteerrorresponse].</docs-info>

[rr-isrouteerrorresponse]: https://reactrouter.com/utils/is-route-error-response
[rr-isrouteerrorresponse]: https://reactrouter.com/v6/utils/is-route-error-response
8 changes: 4 additions & 4 deletions packages/remix-cloudflare/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,10 +480,10 @@

Documentation Resources (better docs specific to Remix are in the works):

- <https://reactrouter.com/en/main/utils/defer>
- <https://reactrouter.com/en/main/components/await>
- <https://reactrouter.com/en/main/hooks/use-async-value>
- <https://reactrouter.com/en/main/hooks/use-async-error>
- <https://reactrouter.com/v6/utils/defer>
- <https://reactrouter.com/v6/components/await>
- <https://reactrouter.com/v6/hooks/use-async-value>
- <https://reactrouter.com/v6/hooks/use-async-error>

- Updated dependencies:
- `@remix-run/[email protected]`
Expand Down
8 changes: 4 additions & 4 deletions packages/remix-deno/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -511,10 +511,10 @@

Documentation Resources (better docs specific to Remix are in the works):

- <https://reactrouter.com/en/main/utils/defer>
- <https://reactrouter.com/en/main/components/await>
- <https://reactrouter.com/en/main/hooks/use-async-value>
- <https://reactrouter.com/en/main/hooks/use-async-error>
- <https://reactrouter.com/v6/utils/defer>
- <https://reactrouter.com/v6/components/await>
- <https://reactrouter.com/v6/hooks/use-async-value>
- <https://reactrouter.com/v6/hooks/use-async-error>

- Updated dependencies:
- `@remix-run/[email protected]`
Expand Down
2 changes: 1 addition & 1 deletion packages/remix-dev/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/remix-express/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions packages/remix-node/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -527,10 +527,10 @@

Documentation Resources (better docs specific to Remix are in the works):

- <https://reactrouter.com/en/main/utils/defer>
- <https://reactrouter.com/en/main/components/await>
- <https://reactrouter.com/en/main/hooks/use-async-value>
- <https://reactrouter.com/en/main/hooks/use-async-error>
- <https://reactrouter.com/v6/utils/defer>
- <https://reactrouter.com/v6/components/await>
- <https://reactrouter.com/v6/hooks/use-async-value>
- <https://reactrouter.com/v6/hooks/use-async-error>

- Updated dependencies:
- `@remix-run/[email protected]`
Expand Down
20 changes: 10 additions & 10 deletions packages/remix-react/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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):

- <https://reactrouter.com/en/main/utils/defer>
- <https://reactrouter.com/en/main/components/await>
- <https://reactrouter.com/en/main/hooks/use-async-value>
- <https://reactrouter.com/en/main/hooks/use-async-error>
- <https://reactrouter.com/v6/utils/defer>
- <https://reactrouter.com/v6/components/await>
- <https://reactrouter.com/v6/hooks/use-async-value>
- <https://reactrouter.com/v6/hooks/use-async-error>

## 1.10.1

Expand All @@ -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

Expand Down
8 changes: 4 additions & 4 deletions packages/remix-serve/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -476,10 +476,10 @@

Documentation Resources (better docs specific to Remix are in the works):

- <https://reactrouter.com/en/main/utils/defer>
- <https://reactrouter.com/en/main/components/await>
- <https://reactrouter.com/en/main/hooks/use-async-value>
- <https://reactrouter.com/en/main/hooks/use-async-error>
- <https://reactrouter.com/v6/utils/defer>
- <https://reactrouter.com/v6/components/await>
- <https://reactrouter.com/v6/hooks/use-async-value>
- <https://reactrouter.com/v6/hooks/use-async-error>

- Updated dependencies:
- `@remix-run/[email protected]`
Expand Down
10 changes: 5 additions & 5 deletions packages/remix-server-runtime/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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):

- <https://reactrouter.com/en/main/utils/defer>
- <https://reactrouter.com/en/main/components/await>
- <https://reactrouter.com/en/main/hooks/use-async-value>
- <https://reactrouter.com/en/main/hooks/use-async-error>
- <https://reactrouter.com/v6/utils/defer>
- <https://reactrouter.com/v6/components/await>
- <https://reactrouter.com/v6/hooks/use-async-value>
- <https://reactrouter.com/v6/hooks/use-async-error>

## 1.10.1

Expand Down
8 changes: 4 additions & 4 deletions packages/remix-testing/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -536,10 +536,10 @@

Documentation Resources (better docs specific to Remix are in the works):

- <https://reactrouter.com/en/main/utils/defer>
- <https://reactrouter.com/en/main/components/await>
- <https://reactrouter.com/en/main/hooks/use-async-value>
- <https://reactrouter.com/en/main/hooks/use-async-error>
- <https://reactrouter.com/v6/utils/defer>
- <https://reactrouter.com/v6/components/await>
- <https://reactrouter.com/v6/hooks/use-async-value>
- <https://reactrouter.com/v6/hooks/use-async-error>

- Updated dependencies:
- `@remix-run/[email protected]`
Expand Down

0 comments on commit d7f4015

Please sign in to comment.