Merge branch 'main' into release-6.4.2-pre.1

Author: chaance

.github/workflows/release-comments.yml

@@ -0,0 +1,35 @@
+name: 📝 Comment on Release
+
+on:
+  workflow_call:
+    inputs:
+      ref:
+        required: true
+        type: string
+
+jobs:
+  comment:
+    name: Comment on Release
+    if: github.repository == 'remix-run/react-router'
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v3
+
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: "yarn"
+
+      - name: 📥 Install deps
+        # even though this is called "npm-install" it does use yarn to install
+        # because we have a yarn.lock and caches efficiently.
+        uses: bahmutov/npm-install@v1
+
+      - name: 📝 Comment on issues
+        run: node ./scripts/release/comment.mjs
+        env:
+          GITHUB_REPOSITORY: ${{ github.repository }}
+          GITHUB_TOKEN: ${{ github.token }}
+          VERSION: ${{ inputs.ref }}

.github/workflows/release.yml

@@ -57,3 +57,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  comment:
+    needs: [release]
+    name: 📝 Comment on related issues and pull requests
+    if: github.repository == 'remix-run/react-router'
+    uses: remix-run/react-router/.github/workflows/release-comments.yml@main
+    with:
+      ref: ${{ github.ref }}

DEVELOPMENT.md

@@ -4,10 +4,11 @@
 
 New releases should be created from release branches originating from the `dev` branch. When you are ready to begin the release process:
 
+- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches
 - Check out the `dev` branch
-- Make sure you have all of the changes from GitHub
 - Create a new release branch with the `release-` prefix (eg, `git checkout -b release-v6.5.1`)
   - **IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release.
+- Merge `main` into the release branch
 
 Changesets will do most of the heavy lifting for our releases. When changes are made to the codebase, an accompanying changeset file should be included to document the change. Those files will dictate how Changesets will version our packages and what shows up in the changelogs.
 

README.md

@@ -7,7 +7,7 @@
 
 React Router is a lightweight, fully-featured routing library for the [React](https://reactjs.org) JavaScript library. React Router runs everywhere that React runs; on the web, on the server (using node.js), and on React Native.
 
-If you're new to React Router, we recommend you start with [the getting started guide](/docs/getting-started/installation.md).
+If you're new to React Router, we recommend you start with [the tutorial](/docs/start/tutorial.md).
 
 If you're migrating to v6 from v5 (or v4, which is the same as v5), check out [the migration guide](/docs/upgrading/v5.md). If you're migrating from Reach Router, check out [the migration guide for Reach Router](/docs/upgrading/reach.md). If you need to find the code for v5, [it is on the `v5` branch](https://github.com/remix-run/react-router/tree/v5).
 

contributors.yml

@@ -1,9 +1,11 @@
+- abdallah-nour
 - abhi-kr-2100
 - Ajayff4
 - alany411
 - alexlbr
 - AmRo045
 - andreiduca
+- aroyan
 - avipatel97
 - awreese
 - aymanemadidi
@@ -19,8 +21,10 @@
 - chensokheng
 - chrisngobanh
 - christopherchudzicki
+- christowiz
 - coryhouse
 - cvbuelow
+- dauletbaev
 - david-crespo
 - dokeet
 - edwin177
@@ -82,13 +86,16 @@
 - ms10596
 - noisypigeon
 - p13i
+- parched
 - paulsmithkc
 - pcattori
 - petersendidit
 - promet99
+- pyitphyoaung
 - RobHannay
 - rtmann
 - ryanflorence
+- ryanhiebert
 - sanketshah19
 - senseibarni
 - sergiodxa
@@ -106,6 +113,7 @@
 - TkDodo
 - tkindy
 - tlinhart
+- triangularcube
 - turansky
 - tyankatsu0105
 - underager

docs/components/link-native.md

@@ -34,7 +34,9 @@ function Home() {
   return (
     <View>
       <Text>Welcome!</Text>
-      <Link to="/profile">Visit your profile</Link>
+      <Link to="/profile">
+        <Text>Visit your profile</Text>
+      </Link>
     </View>
   );
 }

docs/components/link.md

@@ -23,7 +23,7 @@ interface LinkProps
   reloadDocument?: boolean;
 }
 
-type To = Partial<Location> | string;
+type To = string | Partial<Path>;
 ```
 
 </details>

docs/components/scroll-restoration.md

@@ -30,7 +30,7 @@ Optional prop that defines the key React Router should use to restore scroll pos
 
 ```tsx
 <ScrollRestoration
-  getKey={({ location, matches }) => {
+  getKey={(location, matches) => {
     // default behavior
     return location.key;
   }}
@@ -60,7 +60,7 @@ A solid product decision here is to keep the users scroll position on the home f
 
 ```tsx
 <ScrollRestoration
-  getKey={({ location, matches }) => {
+  getKey={(location, matches) => {
     return location.pathname;
   }}
 />
@@ -70,7 +70,7 @@ Or you may want to only use the pathname for some paths, and use the normal beha
 
 ```tsx
 <ScrollRestoration
-  getKey={({ location, matches }) => {
+  getKey={(location, matches) => {
     const paths = ["/home", "/notifications"];
     return paths.includes(location.pathname)
       ? // home and notifications restore by pathname

docs/elements.md

@@ -45,7 +45,7 @@ Examples:
 
 <docs-info>`<Link to>` with a `..` behaves differently from a normal `<a href>` when the current URL ends with `/`. `<Link to>` ignores the trailing slash, and removes one URL segment for each `..`. But an `<a href>` value handles `..` differently when the current URL ends with `/` vs when it does not.</docs-info>
 
-<docs-warning>`useMatches` only works with Data Routers, since they know the full route tree up front and can provide all of the current matches. Additionally, `useMatches` will not match down into any descendant route trees since the router isn't aware of the descendant routes.</docs-warning>
+<docs-warning>`useMatches` only works with a data router like [`createBrowserRouter`][createbrowserrouter], since they know the full route tree up front and can provide all of the current matches. Additionally, `useMatches` will not match down into any descendant route trees since the router isn't aware of the descendant routes.</docs-warning>
 
 <docs-error>Do not do this</docs-error>
 
@@ -182,3 +182,4 @@ Lines that overflow:
 ---
 
 [$link]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
+[createbrowserrouter]: ./routers/create-browser-router

docs/fetch/json.md

@@ -10,7 +10,7 @@ A shortcut for:
 ```jsx
 new Response(JSON.stringify(someValue), {
   headers: {
-    "Content-Type": "application/json; utf-9",
+    "Content-Type": "application/json; utf-8",
   },
 });
 ```