Skip to content

Commit e9ed28e

Browse files
docs(start): fix grammar + typos (#10656)
1 parent 1afa284 commit e9ed28e

File tree

4 files changed

+56
-56
lines changed

4 files changed

+56
-56
lines changed

docs/start/community.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,25 @@ We work hard to keep the Remix community a friendly place where people want to h
1010

1111
To that end, please keep in mind [our code of conduct][our-code-of-conduct].
1212

13-
- [Remix Discord][remix-discord-server] - A great place to have conversations, ask and answer questions, all about Remix.
13+
- [Remix Discord][remix-discord-server] A great place to have conversations, ask and answer questions, all about Remix.
1414

15-
- [GitHub Discussions][git-hub-discussions-forum] - This is the best place to propose changes to Remix. The team uses it to gauge interest and understand use cases.
15+
- [GitHub Discussions][git-hub-discussions-forum] This is the best place to propose changes to Remix. The team uses it to gauge interest and understand use cases.
1616

17-
- [Remix Twitter][twitter] - Tips, updates, and news about Remix from the team.
17+
- [Remix Twitter][twitter] Tips, updates, and news about Remix from the team.
1818

19-
- [Examples][the-examples-repository] - Dozens of Remix examples from the team and community.
19+
- [Examples][the-examples-repository] Dozens of Remix examples from the team and community.
2020

21-
- [Remix Conf][remix-conf] - A yearly conference all about Remix with talks primarily from the community.
21+
- [Remix Conf][remix-conf] A yearly conference all about Remix with talks primarily from the community.
2222

23-
- [Remix Mailing List][official-remix-team-mailing-list] - Not-so-regular email from the Remix team letting you know what the team is up to.
23+
- [Remix Mailing List][official-remix-team-mailing-list] Not-so-regular email from the Remix team letting you know what the team is up to.
2424

25-
- [Meetups][the-remix-meetup-page] - There are Remix Meetups all over the world with thousands of members. Some online, some in person, and some a hybrid of the two.
25+
- [Meetups][the-remix-meetup-page] There are Remix Meetups all over the world with thousands of members. Some online, some in person, and some a hybrid of the two.
2626

27-
- [Remix Guide][remix-guide] - A wonderful community site that gathers together everything that's going on in the Remix ecosystem: online courses, blog posts, app templates, events and more.
27+
- [Remix Guide][remix-guide] A wonderful community site that gathers everything that's going on in the Remix ecosystem: online courses, blog posts, app templates, events, and more.
2828

29-
- [Moulton][moulton] - Community Remix newsletter
29+
- [Moulton][moulton] Community Remix newsletter
3030

31-
- [Releases on GitHub][releases-on-git-hub] - Not a bad idea to subscribe to Remix releases, so you know what's coming.
31+
- [Releases on GitHub][releases-on-git-hub] Not a bad idea to subscribe to Remix releases, so you know what's coming.
3232

3333
[our-code-of-conduct]: https://github.com/remix-run/remix/blob/main/CODE_OF_CONDUCT.md
3434
[remix-discord-server]: https://rmx.as/discord

docs/start/future-flags.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ order: 5
55

66
# Future Flags and Deprecations
77

8-
This guide walks you through the process of adopting future flags in your Remix app. By following this strategy, you will be able to upgrade to the next major version of Remix with minimal changes. To read more about future flags see [Development Strategy][development-strategy].
8+
This guide walks you through the process of adopting future flags in your Remix app. By following this strategy, you will be able to upgrade to the next major version of Remix with minimal changes. To read more about future flags, see [Development Strategy][development-strategy].
99

1010
We highly recommend you make a commit after each step and ship it instead of doing everything all at once. Most flags can be adopted in any order, with exceptions noted below.
1111

@@ -23,11 +23,11 @@ npm install @remix-run/{dev,react,node,etc.}@2
2323

2424
**Background**
2525

26-
Previously Remix required a `fetch` polyfill to be installed. This was accomplished by calling `installGlobals()`.
26+
Previously Remix required a `fetch` polyfill to be installed. This was achieved by calling `installGlobals()`.
2727

2828
The next major version requires a minimum of Node 20 to take advantage of the built-in `fetch` support.
2929

30-
Note: if you are using miniflare/cloudflare worker with your remix project, ensure your [compatibility flag][compatibility-flag] is set to `2023-03-01` or later as well.
30+
Note: if you are using Miniflare/Cloudflare worker with your remix project, ensure your [compatibility flag][compatibility-flag] is set to `2023-03-01` or later as well.
3131

3232
👉 **Update to Node 20+**
3333

@@ -50,7 +50,7 @@ export default defineConfig({
5050

5151
**Background**
5252

53-
Remix no longer uses its own, closed compiler (now referred to as the "Classic Compiler"), and instead uses [Vite][vite]. Vite is a powerful, performant and extensible development environment for JavaScript projects. [View the Vite docs][vite-docs] for more information on performance, troubleshooting, etc.
53+
Remix no longer uses its own, closed compiler (now referred to as the "Classic Compiler") and instead uses [Vite][vite]. Vite is a powerful, performant and extensible development environment for JavaScript projects. [View the Vite docs][vite-docs] for more information on performance, troubleshooting, etc.
5454

5555
While this is not a future flag, new features and some feature flags are only available in the Vite plugin, and the Classic Compiler will be removed in the next version of Remix.
5656

@@ -89,7 +89,7 @@ export default defineConfig({
8989

9090
Many users found that automatically [optimizing dependencies][dependency-optimization] helped them more easily adopt the Vite plugin. For this reason we added the `unstable_optimizeDeps` flag to the Vite plugin.
9191

92-
This flag will remain in an "unstable" state until React Router v7 so it is not critical that you adopt this in your Remix v2 app prior to upgrading to React Router v7.
92+
This flag will remain in an "unstable" state until React Router v7, so it is not critical that you adopt this in your Remix v2 app before upgrading to React Router v7.
9393

9494
```ts filename=vite.config.ts lines=[4-6]
9595
export default defineConfig({
@@ -369,7 +369,7 @@ You likely won't need to adjust any code, unless you had custom logic inside of
369369

370370
**Background**
371371

372-
With this flag, Remix no longer sends the full route manifest up to the client on initial load. Instead, Remix only sends the server-rendered routes up in the manifest and then fetches the remaining routes as the user navigated around the application. Additional details are available in the [docs][lazy-route-discovery] and the [blog post][lazy-route-discovery-blog-post]
372+
With this flag, Remix no longer sends the full route manifest up to the client on initial load. Instead, Remix only sends the server-rendered routes up in the manifest and then fetches the remaining routes as the user navigates around the application. Additional details are available in the [docs][lazy-route-discovery] and the [blog post][lazy-route-discovery-blog-post]
373373

374374
👉 **Enable the Flag**
375375

@@ -527,7 +527,7 @@ This flag requires the [Vite plugin][vite-plugin].
527527

528528
Config-based routing is the new default in React Router v7, configured via the `routes.ts` file in the app directory. Support for `routes.ts` and its related APIs in Remix are designed as a migration path to help minimize the number of changes required when moving your Remix project over to React Router v7. While some new packages have been introduced within the `@remix-run` scope, these new packages only exist to keep the code in `routes.ts` as similar as possible to the equivalent code for React Router v7.
529529

530-
When the `v3_routeConfig` future flag is enabled, Remix's built-in file system routing will be disabled and your project will opted into React Router v7's config-based routing. If you prefer to keep using Remix's file-based routing we cover how to enable it in `routes.ts` below.
530+
When the `v3_routeConfig` future flag is enabled, Remix's built-in file system routing will be disabled and your project will opt into React Router v7's config-based routing. If you prefer to keep using Remix's file-based routing, we cover how to enable it in `routes.ts` below.
531531

532532
**Update your code**
533533

@@ -650,7 +650,7 @@ export default [
650650
] satisfies RouteConfig;
651651
```
652652

653-
Note that if you need to mix and match different route config approaches, they can be merged together into a single array of routes. The `RouteConfig` type ensures that everything is still valid.
653+
Note that if you need to mix and match different route config approaches, they can be merged into a single array of routes. The `RouteConfig` type ensures that everything is still valid.
654654

655655
```ts
656656
import { flatRoutes } from "@remix-run/fs-routes";
@@ -714,7 +714,7 @@ The following utilities are deprecated and will be removed in React Router v7:
714714

715715
We recommend using [`@mjackson/form-data-parser`][form-data-parser] and [`@mjackson/file-storage`][file-storage] to handle multipart form data and file uploads.
716716

717-
You can also checkout the [React Router "File Uploads" doc][react-router-file-uploads] or ["File uploads with Remix"][file-uploads-with-remix] blog post for guides on using these libraries.
717+
You can also check out the [React Router "File Uploads" doc][react-router-file-uploads] or ["File uploads with Remix"][file-uploads-with-remix] blog post for guides on using these libraries.
718718

719719
[development-strategy]: ../guides/api-development-strategy
720720
[fetcherpersist-rfc]: https://github.com/remix-run/remix/discussions/7698

docs/start/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ If you prefer to initialize a batteries-included Remix project, you can use the
1919
npx create-remix@latest
2020
```
2121

22-
However, this guide will explain everything the CLI does to set up your project, and instead of using the CLI you can follow these steps. If you're just getting started with Remix, we recommend following this guide to understand all of the different pieces that make up a Remix app.
22+
However, this guide will explain everything the CLI does to set up your project, and instead of using the CLI, you can follow these steps. If you're just getting started with Remix, we recommend following this guide to understand all the different pieces that make up a Remix app.
2323

2424
```shellscript nonumber
2525
mkdir my-remix-app
@@ -243,7 +243,7 @@ app.listen(3000, () => {
243243
npm run dev
244244
```
245245

246-
Now you can work on your app with immediate feedback. Give it a shot, change the text in `root.jsx` and watch!
246+
Now you can work on your app with immediate feedback. Give it a try, change the text in `root.jsx` and watch!
247247

248248
## Controlling Server and Browser Entries
249249

0 commit comments

Comments
 (0)