Skip to content

Commit 0cc6a84

Browse files
authored
Fix spelling and capitalization errors in documentation (#212)
1 parent 72579cb commit 0cc6a84

File tree

22 files changed

+32
-32
lines changed

22 files changed

+32
-32
lines changed

next.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
// let assetPrefix = undefined;
55

66
///** Deploys as a directory through GitHub Actions **/
7-
//const isGithubActions = process.env.GITHUB_ACTIONS || false
7+
//const isGitHubActions = process.env.GITHUB_ACTIONS || false
88
//
9-
//if (isGithubActions) {
9+
//if (isGitHubActions) {
1010
// // trim off `<owner>/`
1111
// const repo = process.env.GITHUB_REPOSITORY.replace(/.*?\//, '')
1212
//

pages/aws/config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ There is two build arguments that you can pass to the `open-next build` command:
77

88
### Configuration File
99

10-
For personalisation you need to create a file `open-next.config.ts` at the same place as your `next.config.js`, and export a default object that satisfies the `OpenNextConfig` interface. It is possible to not have an `open-next.config.ts` file, the default configuration will then be applied automatically.
10+
For personalization you need to create a file `open-next.config.ts` at the same place as your `next.config.js`, and export a default object that satisfies the `OpenNextConfig` interface. It is possible to not have an `open-next.config.ts` file, the default configuration will then be applied automatically.
1111

1212
This file needs to be placed at the same level as your `next.config.js` file.
1313

pages/aws/config/nx.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ export default $config({
159159
$ cd apps/next-site && sst install
160160
```
161161

162-
this will resolve the type issues and initialise SST.
162+
this will resolve the type issues and initialize SST.
163163

164164
- next we need to add `sst.config.ts` to our `tsconfig.json`'s excludes array
165165

pages/aws/contribute/plugin.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ openNextPlugin({
1616
deletes: ["id1"],
1717
})
1818

19-
//To inject arbritary code by using (import at top of file):
19+
//To inject arbitrary code by using (import at top of file):
2020

2121
//#import
2222

@@ -63,7 +63,7 @@ openNextEdgePlugin({
6363
nextDir: "next",
6464
// The path to the edgeFunctionHandler.js file that we'll use to bundle the routing
6565
edgeFunctionHandlerPath: "./edgeFunctionHandler.js",
66-
// The middlewareInfo from the middlware manifest file
66+
// The middlewareInfo from the middleware manifest file
6767
middlewareInfo: middlewareInfo
6868
// If the app should be bundled for cloudflare workers
6969
isInCloudflare: true

pages/aws/inner_workings/components/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Every backend is a separate module. The following backends are available:
2424
- Warmer
2525
- Initializer
2626

27-
All these backends can be overrided to fit your needs. They share some common ground for the configuration and the way they are used.
27+
All these backends can be overridden to fit your needs. They share some common ground for the configuration and the way they are used.
2828

2929
### Common Overrides
3030

pages/aws/v2/inner_workings/plugin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { Callout } from "nextra/components";
22

3-
Open-next use esbuild to build the project. Given that we aim to support multiple version of Next and multiple runtime, we developped a plugin to override some parts of our code at build time with an esbuild plugin.
3+
Open-next use esbuild to build the project. Given that we aim to support multiple version of Next and multiple runtime, we developed a plugin to override some parts of our code at build time with an esbuild plugin.
44

55
<Callout type="warning" emoji="⚠️">
66
As of now, the plugin is internal and not exposed to the user. We might expose it in the future, but for

pages/cloudflare/caching.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Tabs } from "nextra/components";
55

66
Next.js offers multiple ways to improve an application's performance by [caching](https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#caching-data) routes and network requests. An application will try to pre-render and cache as much data as possible during build-time to reduce the amount of work required when serving a response to a user.
77

8-
The cache data are updated using revalidation, either peridiocally or on-demand:
8+
The cache data are updated using revalidation, either periodically or on-demand:
99

1010
- "[Time-based revalidation](https://nextjs.org/docs/app/building-your-application/data-fetching/incremental-static-regeneration#time-based-revalidation)" updates the cache data after the revalidation delay specified by the applications expires
1111
- "[On-demand revalidation](https://nextjs.org/docs/app/building-your-application/data-fetching/incremental-static-regeneration#on-demand-revalidation-with-revalidatetag)" allows to invalid cache entries with a specific tag (via `revalidateTag`) or at a given path (via `revalidatePath`). You can also use `res.revalidate` in Pages router API route.
@@ -585,9 +585,9 @@ export default defineCloudflareConfig({
585585
});
586586
```
587587

588-
##### 4. Initialise the cache during deployments
588+
##### 4. Initialize the cache during deployments
589589

590-
In order for the cache to be properly initialised with the build-time revalidation data, you need to run a command as part of your deploy step. This should be run as part of each deployment to ensure that the cache is being populated with each build's data.
590+
In order for the cache to be properly initialized with the build-time revalidation data, you need to run a command as part of your deploy step. This should be run as part of each deployment to ensure that the cache is being populated with each build's data.
591591

592592
To populate remote bindings and create a new [version](https://developers.cloudflare.com/workers/configuration/versions-and-deployments/#versions) of your application at the same time, you can use either the [`deploy`](/cloudflare/cli#deploy-command) command or the [`upload`](/cloudflare/cli#upload-command) command. Similarly, the [`preview`](/cloudflare/cli#preview-command) command will populate your local bindings and start a Wrangler dev server.
593593

pages/cloudflare/community.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Here is a list of some of the features it includes:
1717
- Rate Limiting with Cloudflare KV to prevent abuse
1818
- Validation for all user actions with react-zsa and zod
1919
- Database: Drizzle ORM and Cloudflare D1
20-
- UI: Shadcn, Tailwind CSS and Hero UI (formely NextUI)
20+
- UI: `shadcn/ui`, Tailwind CSS and HeroUI (formerly NextUI)
2121
- Transactional email templates with react-email and integration with Resend and Brevo
2222
- Dev Experience
2323
- Completely type safe
@@ -26,5 +26,5 @@ Here is a list of some of the features it includes:
2626
- .cursorrules
2727
- A markdown project documentation that Cursor can refer to for more context and better responses
2828
- Detailed documentation for local development and production deployment
29-
- Automatic deployment using Github Actions and the Wrangler CLI
29+
- Automatic deployment using GitHub Actions and the Wrangler CLI
3030
- And more...

pages/cloudflare/former-releases/0.2/get-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,4 +137,4 @@ Either deploy via the command line:
137137
npm run deploy:worker
138138
```
139139

140-
Or [connect a Github or Gitlab repository](https://developers.cloudflare.com/workers/ci-cd/), and Cloudflare will automatically build and deploy each pull request you merge to your production branch.
140+
Or [connect a GitHub or GitLab repository](https://developers.cloudflare.com/workers/ci-cd/), and Cloudflare will automatically build and deploy each pull request you merge to your production branch.

pages/cloudflare/former-releases/0.3/caching.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ By default, all `fetch()` subrequests made in your Next.js app are cached. Refer
1010

1111
Note that [Revalidating](https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#revalidating-data) is not yet supported.
1212

13-
Next.js primes the cache at build time. The build time values are serverd by the [Workers Assets](https://developers.cloudflare.com/workers/static-assets/).
13+
Next.js primes the cache at build time. The build time values are served by the [Workers Assets](https://developers.cloudflare.com/workers/static-assets/).
1414

1515
<Callout>
1616
Workers KV is eventually consistent, which means that it can take up to 60 seconds for updates to be

0 commit comments

Comments
 (0)