From 9279fd30c8c8b2f5b33755792bc7f1adb7b3b5df Mon Sep 17 00:00:00 2001 From: Brooks Lybrand Date: Thu, 19 Dec 2024 09:31:50 -0600 Subject: [PATCH] docs(upgrading): improve callout for .gitignore --- docs/upgrading/component-routes.md | 10 ++++++++-- docs/upgrading/router-provider.md | 8 ++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/upgrading/component-routes.md b/docs/upgrading/component-routes.md index bb0fdecfca..39ca8634b1 100644 --- a/docs/upgrading/component-routes.md +++ b/docs/upgrading/component-routes.md @@ -257,14 +257,20 @@ At this point you should be able to to boot the app and see the root layout. } ``` -> Note: Make sure to add `/.react-router/` to your `.gitignore` file to avoid tracking unnecessary files in your repository. - Now make sure you can boot your app at this point before moving on: ```shellscript npm run dev ``` +You will probably want to add `.react-router/` to your `.gitignore` file to avoid tracking unnecessary files in your repository. + +```txt +.react-router/ +``` + +You can checkout [Type Safety][type-safety] to learn how to fully setup and use autogenerated type safety for params, loader data, and more. + ## 8. Render your app To get back to rendering your app, we'll update the "catchall" route we setup earlier that matches all URLs so that your existing `` get a chance to render. diff --git a/docs/upgrading/router-provider.md b/docs/upgrading/router-provider.md index 17ee5694c3..aada0c1496 100644 --- a/docs/upgrading/router-provider.md +++ b/docs/upgrading/router-provider.md @@ -412,6 +412,14 @@ Now make sure you can boot your app at this point before moving on: npm run dev ``` +You will probably want to add `.react-router/` to your `.gitignore` file to avoid tracking unnecessary files in your repository. + +```txt +.react-router/ +``` + +You can checkout [Type Safety][type-safety] to learn how to fully setup and use autogenerated type safety for params, loader data, and more. + ## Enable SSR and/or Pre-rendering If you want to enable server rendering and static pre-rendering, you can do so with the `ssr` and `prerender` options in the bundler plugin. For SSR you'll need to also deploy the server build to a server. See [Deploying][deploying] for more information.