Skip to content

Commit

Permalink
docs: fix some broken links and prerelease references
Browse files Browse the repository at this point in the history
  • Loading branch information
brookslybrand committed Nov 22, 2024
1 parent 6ba3738 commit 2a20ec3
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/start/framework/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,5 +167,5 @@ See the [Using Fetchers][fetchers] guide for more information.

Next: [Navigating](./navigating)

[fetchers]: ../how-to/fetchers
[fetchers]: ../../how-to/fetchers
[data]: ../../api/react-router/data
5 changes: 3 additions & 2 deletions docs/start/framework/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ order: 1
Most projects start with a template. Let's use a basic template maintained by React Router:

```shellscript nonumber
npm create react-router@pre my-react-router-app
npx create-react-router@latest my-react-router-app
```

Now change into the new directory and start the app
Expand All @@ -21,7 +21,7 @@ npm run dev

You can now open your browser to `http://localhost:5173`

You can [view the template on GitHub](https://github.com/remix-run/react-router/tree/dev/templates/basic) to see how to manually set up your project.
You can [view the template on GitHub][default-template] to see how to manually set up your project.

<!-- TODO: Show how to find and use community templates -->

Expand All @@ -30,3 +30,4 @@ You can [view the template on GitHub](https://github.com/remix-run/react-router/
Next: [Routing](./routing)

[manual_usage]: ../how-to/manual-usage
[default-template]: https://github.com/remix-run/react-router-templates/tree/main/default
2 changes: 1 addition & 1 deletion docs/start/framework/navigating.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ If the user enters "journey" into the input and submits it, they will navigate t
/search?q=journey
```

Forms with `<Form method="post" />` will also navigate to the action prop but will submit the data as `FormData` instead of `URLSearchParams`. However, it is more common to `useFetcher()` to POST form data. See [Using Fetchers](../how-to/fetchers).
Forms with `<Form method="post" />` will also navigate to the action prop but will submit the data as `FormData` instead of `URLSearchParams`. However, it is more common to `useFetcher()` to POST form data. See [Using Fetchers](../../how-to/fetchers).

## redirect

Expand Down
2 changes: 1 addition & 1 deletion docs/start/framework/pending-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ function Task({ task }) {

Next: [Testing](./testing)

[use_fetcher]: ../hooks/use-fetcher
[use_fetcher]: https://api.reactrouter.com/v7/functions/react_router.useFetcher.html
8 changes: 1 addition & 7 deletions docs/upgrading/remix.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Adopt all existing [future flags][v2-future-flags] in your Remix v2 application.
Most of the "shared" APIs that used to be re-exported through the runtime-specific packages (`@remix-run/node`, `@remix-run/cloudflare`, etc.) have all been collapsed into `react-router` in v7. So instead of importing from `@react-router/node` or `@react-router/cloudflare`, you'll import those directly from `react-router`.

```diff
-import { redirect } from "@react-router/node";
-import { redirect } from "@remix-run/node";
+import { redirect } from "react-router";
```

Expand All @@ -44,12 +44,6 @@ npx codemod remix/2/react-router/upgrade

After the codemod updates your dependencies, you need to install the dependencies to remove Remix packages and add the new React Router packages.

<docs-warning>

While still in prerelease, you need to update your `package.json` to point to the prerelease versions of the `react-router` packages.

</docs-warning>

```shellscript nonumber
npm install
```
Expand Down
4 changes: 2 additions & 2 deletions docs/upgrading/v6.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ npm install react-router-dom@6

**Background**

Changes the relative path matching and linking for multi-segment splats paths like `dashboard/*` (vs. just `*`). [View the CHANGELOG](https://github.com/remix-run/react-router/blob/main/packages/react-router-dom/CHANGELOG.md#minor-changes-2) for more information.
Changes the relative path matching and linking for multi-segment splats paths like `dashboard/*` (vs. just `*`). [View the CHANGELOG](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#futurev7_relativesplatpath) for more information.

👉 **Enable the flag**

Expand Down Expand Up @@ -107,7 +107,7 @@ function Dashboard() {

**Background**

This uses `React.useTransition` instead of `React.useState` for Router state updates. View the [CHANGELOG](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#v7_starttransition) for more information.
This uses `React.useTransition` instead of `React.useState` for Router state updates. View the [CHANGELOG](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#futurev7_starttransition) for more information.

👉 **Enable the flag**

Expand Down

0 comments on commit 2a20ec3

Please sign in to comment.