docs(other-api): fix grammar + typos (#10654)

MichaelDeBoey · web-flow · commit 591600f74ae4 · 2025-06-09T08:38:33.000-05:00
diff --git a/docs/other-api/adapter.md b/docs/other-api/adapter.md
@@ -24,15 +24,15 @@ Each adapter has the same API. In the future we may have helpers specific to the
 
 ## Community Adapters
 
-- [`@fastly/remix-server-adapter`][fastly-remix-server-adapter] - For [Fastly Compute][fastly-compute].
-- [`@mcansh/remix-fastify`][remix-fastify] - For [Fastify][fastify].
-- [`@mcansh/remix-raw-http`][remix-raw-http] - For a good old bare bones Node server.
-- [`@netlify/remix-adapter`][netlify-remix-adapter] - For [Netlify][netlify].
-- [`@netlify/remix-edge-adapter`][netlify-remix-edge-adapter] - For [Netlify][netlify] Edge.
-- [`@vercel/remix`][vercel-remix] - For [Vercel][vercel].
-- [`remix-google-cloud-functions`][remix-google-cloud-functions] - For [Google Cloud][google-cloud-functions] and [Firebase][firebase-functions] functions.
-- [`partymix`][partymix] - For [PartyKit][partykit].
-- [`@scandinavianairlines/remix-azure-functions`][remix-azure-functions]: For [Azure Functions][azure-functions] and [Azure Static Web Apps][azure-static-web-apps].
+- [`@fastly/remix-server-adapter`][fastly-remix-server-adapter] — For [Fastly Compute][fastly-compute].
+- [`@mcansh/remix-fastify`][remix-fastify] — For [Fastify][fastify].
+- [`@mcansh/remix-raw-http`][remix-raw-http] — For a good old bare-bones Node.js server.
+- [`@netlify/remix-adapter`][netlify-remix-adapter] — For [Netlify][netlify].
+- [`@netlify/remix-edge-adapter`][netlify-remix-edge-adapter] — For [Netlify][netlify] Edge.
+- [`@vercel/remix`][vercel-remix] — For [Vercel][vercel].
+- [`remix-google-cloud-functions`][remix-google-cloud-functions] — For [Google Cloud][google-cloud-functions] and [Firebase][firebase-functions] functions.
+- [`partymix`][partymix] — For [PartyKit][partykit].
+- [`@scandinavianairlines/remix-azure-functions`][remix-azure-functions] — For [Azure Functions][azure-functions] and [Azure Static Web Apps][azure-static-web-apps].
 
 ## Creating an Adapter
 
@@ -65,7 +65,7 @@ app.all(
     // to pass that build to the request handler
     build: require("./build"),
 
-    // return anything you want here to be available as `context` in your
+    // Return anything you want here to be available as `context` in your
     // loaders and actions. This is where you can bridge the gap between Remix
     // and your server
     getLoadContext(req, res) {
diff --git a/docs/other-api/create-remix.md b/docs/other-api/create-remix.md
@@ -8,33 +8,33 @@ title: "create-remix (CLI)"
 
 The `create-remix` CLI will create a new Remix project. Without passing arguments, this command will launch an interactive CLI to configure the new project and set it up in a given directory.
 
-```sh
+```shellscript nonumber
 npx create-remix@latest
 ```
 
-Optionally you can pass the desired directory path as an argument:
+Optionally, you can pass the desired directory path as an argument:
 
-```sh
+```shellscript nonumber
 npx create-remix@latest <projectDir>
 ```
 
-The default application is a TypeScript app using the built in [Remix App Server][remix-app-server]. If you wish to create your application based on a different setup, you can use the [`--template`][template-flag-hash-link] flag:
+The default application is a TypeScript app using the built-in [Remix App Server][remix-app-server]. If you wish to create your application based on a different setup, you can use the [`--template`][template-flag-hash-link] flag:
 
-```sh
+```shellscript nonumber
 npx create-remix@latest --template <templateUrl>
 ```
 
 To get a full list of available commands and flags, run:
 
-```sh
+```shellscript nonumber
 npx create-remix@latest --help
 ```
 
 ### Package managers
 
-`create-remix` can also be invoked using various package managers, allowing you to choose between npm, Yarn, pnpm, and Bun for managing the install process.
+`create-remix` can also be invoked using various package managers, allowing you to choose between npm, Yarn, pnpm, and Bun for managing the installation process.
 
-```sh
+```shellscript nonumber
 npm create remix@latest <projectDir>
 # or
 yarn create remix@latest <projectDir>
@@ -57,7 +57,7 @@ A valid template can be:
 - a local file path to a directory of files — `./path/to/remix-template`
 - a local file path to a tarball — `./path/to/remix-template.tar.gz`
 
-```sh
+```shellscript nonumber
 npx create-remix@latest ./my-app --template remix-run/grunge-stack
 npx create-remix@latest ./my-app --template remix-run/remix/templates/remix
 npx create-remix@latest ./my-app --template remix-run/examples/basic
diff --git a/docs/other-api/dev.md b/docs/other-api/dev.md
@@ -102,13 +102,13 @@ HMR handles client-side code updates like when you change the components, markup
 Likewise, HDR handles server-side code updates.
 
 That means any time your change a [`loader`][loader] on your current page (or any code that your `loader` depends on), Remix will re-fetch data from your changed loader.
-That way your app is _always_ up-to-date with the latest code changes, client-side or server-side.
+That way your app is _always_ up to date with the latest code changes, client-side or server-side.
 
 To learn more about how HMR and HDR work together, check out [Pedro's talk at Remix Conf 2023][legendary_dx].
 
 </docs-info>
 
-#### With custom app server
+#### With a custom app server
 
 If you used a template to get started, hopefully it's already integrated with `remix dev` out-of-the-box.
 If not, you can follow these steps to integrate your project with `remix dev`:
@@ -200,7 +200,7 @@ remix dev -c "remix-serve --port 8000 ./build/index.js"
 ```
 
 In contrast, the `remix dev --port` option is an escape-hatch for users who need fine-grain control of network ports.
-Most users, should not need to use `remix dev --port`.
+Most users should not need to use `remix dev --port`.
 
 #### Manual mode
 
@@ -214,7 +214,7 @@ You can see if app server restarts are a bottleneck for your project by comparin
 
 #### Pick up changes from other packages
 
-If you are using a monorepo, you might want Remix to perform hot updates not only when your app code changes, but whenever you change code in any of your apps dependencies.
+If you are using a monorepo, you might want Remix to perform hot updates not only when your app code changes, but whenever you change code in any of your app's dependencies.
 
 For example, you could have a UI library package (`packages/ui`) that is used within your Remix app (`packages/app`).
 To pick up changes in `packages/ui`, you can configure [watchPaths][watch_paths] to include your packages.
@@ -238,7 +238,7 @@ For example, you can use `NODE_OPTIONS` to set Node's `--require` flag when runn
 }
 ```
 
-If you're using ESM as the default module system you will need to set the `--import` flag instead of `--require`:
+If you're using ESM as the default module system, you will need to set the `--import` flag instead of `--require`:
 
 ```json filename=package.json
 {
@@ -295,11 +295,11 @@ Now, hot updates will be sent correctly to the proxy:
 ##### Path imports
 
 Currently, when Remix rebuilds your app, the compiler has to process your app code along with any of its dependencies.
-The compiler tree-shakes unused code from app so that you don't ship any unused code to browser and so that you keep your server as slim as possible.
+The compiler tree-shakes unused code from the app so that you don't ship any unused code to the browser and so that you keep your server as slim as possible.
 But the compiler still needs to _crawl_ all the code to know what to keep and what to tree shake away.
 
 In short, this means that the way you do imports and exports can have a big impact on how long it takes to rebuild your app.
-For example, if you are using a library like Material UI or AntD you can likely speed up your builds by using [path imports][path_imports]:
+For example, if you are using a library like Material UI or AntD, you can likely speed up your builds by using [path imports][path_imports]:
 
 ```diff
 - import { Button, TextField } from '@mui/material';
@@ -327,7 +327,7 @@ check out our [discussion on Hot Module Replacement][hmr] to learn more about th
 Hot Data Revalidation detects loader changes by trying to bundle each loader and then fingerprinting the content for each.
 It relies on tree shaking to determine whether your changes affect each loader or not.
 
-To ensure that tree shaking can reliably detect changes to loaders, make sure you declare that your app's package is side effect free:
+To ensure that tree shaking can reliably detect changes to loaders, make sure you declare that your app's package is side-effect-free:
 
 ```json filename=package.json
 {
diff --git a/docs/other-api/node.md b/docs/other-api/node.md
@@ -8,7 +8,7 @@ This package contains utilities and polyfills for Node.js.
 
 ## Polyfills
 
-Since Remix relies on browser APIs such as `fetch` that aren't natively & stably available yet in Node.js you may find that your unit tests fail without these globals when running with tools such as Jest.
+Since Remix relies on browser APIs such as `fetch` that aren't natively and stably available yet in Node.js you may find that your unit tests fail without these globals when running with tools such as Jest.
 
 Your testing framework should provide you with a hook or location to polyfill globals / mock out APIs; here you can add the following lines to install the globals that Remix relies on:
 
diff --git a/docs/other-api/serve.md b/docs/other-api/serve.md
@@ -5,11 +5,11 @@ order: 3
 
 # Remix App Server
 
-Remix is designed for you to own your server, but if you don't want to set one up you can use the Remix App Server instead. It's a production-ready, but basic Node.js server built with Express.
+Remix is designed for you to own your server, but if you don't want to set one up, you can use the Remix App Server instead. It's a production-ready but basic Node.js server built with Express.
 
-By design, we do not provide options to customize the Remix App Server because if you need to customize the underlying `express` server, we'd rather you manage the server completely instead of creating an abstraction to handle all of the possible customizations you may require. If you find you want to customize it, you should use the `@remix-run/express` adapter instead.
+By design, we do not provide options to customize the Remix App Server because if you need to customize the underlying `express` server, we'd rather you manage the server completely instead of creating an abstraction to handle all the possible customizations you may require. If you find you want to customize it, you should use the `@remix-run/express` adapter instead.
 
-You can see the underlying `express` server configuration in [packages/remix-serve/cli.ts][remix-serve-code]. By default it uses the following Express middlewares (please refer to their documentation for default behaviors):
+You can see the underlying `express` server configuration in [packages/remix-serve/cli.ts][remix-serve-code]. By default, it uses the following Express middlewares (please refer to their documentation for default behaviors):
 
 - [`compression`][compression]
 - [`express.static`][express-static] (and thus [`serve-static`][serve-static])
@@ -69,7 +69,7 @@ In development, `remix-serve` will ensure the latest code is run by purging the
 
   If you need a workaround for preserving cache in development, you can set up a [singleton][singleton] in your server.
 
-- Any **module side effects** will remain in place! This may cause problems, but should probably be avoided anyway.
+- Any **module side effects** will remain in place! This may cause problems but should probably be avoided anyway.
 
   ```tsx lines=[3-6]
   import { json } from "@remix-run/node"; // or cloudflare/deno
@@ -86,7 +86,7 @@ In development, `remix-serve` will ensure the latest code is run by purging the
 
   If you need to write your code in a way that has these types of module side effects, you should set up your own [@remix-run/express][remix-run-express] server and a tool in development like pm2-dev or nodemon to restart the server on file changes instead.
 
-In production this doesn't happen. The server boots up and that's the end of it.
+In production this doesn't happen. The server boots up, and that's the end of it.
 
 [remix-run-express]: ./adapter#createrequesthandler
 [singleton]: ../guides/manual-mode#keeping-in-memory-server-state-across-rebuilds
diff --git a/docs/other-api/testing.md b/docs/other-api/testing.md
@@ -6,7 +6,7 @@ title: "@remix-run/testing"
 
 This package contains utilities to assist in unit testing portions of your Remix application. This is accomplished by mocking the Remix route modules/assets manifest output by the compiler and generating an in-memory React Router app via [createMemoryRouter][create-memory-router].
 
-The general usage of this is to test components/hooks that rely on Remix hooks/components which you do not have the ability to cleanly mock ([`useLoaderData`][use-loader-data], [`useFetcher`][use-fetcher], etc.). While it can also be used for more advanced testing such as clicking links and navigating to pages, those are better suited for End-to-End tests via something like [Cypress][cypress] or [Playwright][playwright].
+The general usage of this is to test components/hooks that rely on Remix hooks/components which you aren't able to cleanly mock ([`useLoaderData`][use-loader-data], [`useFetcher`][use-fetcher], etc.). While it can also be used for more advanced testing such as clicking links and navigating to pages, those are better suited for End-to-End tests via something like [Cypress][cypress] or [Playwright][playwright].
 
 ## Usage
 
