Skip to content

Fix typos in documentation files #80344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 16 commits into from
Closed

Fix typos in documentation files #80344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
a455a85
Fix typos in documentation files
atsushi196323 Jun 10, 2025
c1da2ed
Revert incorrect change to %5FfolderName
atsushi196323 Jun 10, 2025
81c7743
Fix typos in documentation files
atsushi196323 Jun 10, 2025
b829b98
[turbopack] Remove the `_for_input` options from `turbo_tasks::value`…
lukesandberg Jun 9, 2025
a2166e0
Docs: Add rspack community collab (#80217)
icyJoseph Jun 9, 2025
057f8fd
[dev-overlay] Publish as production bundle (#80295)
eps1lon Jun 9, 2025
0ea81b4
chore(turbopack/ci): Make codspeed stable (#80323)
kdy1 Jun 9, 2025
0a07743
[metadata] only serve block streaming metadata for html bots (#80272)
huozhi Jun 9, 2025
a071cad
v15.4.0-canary.73
vercel-release-bot Jun 9, 2025
91dd855
[test] separate tracing error test from action test suite (#80324)
huozhi Jun 9, 2025
1b3e59b
chore(next-swc-napi): Update tracing-chrome crate to 0.7.2 (#80331)
bgw Jun 9, 2025
0bf6fd5
Update font data (#80301)
vercel-release-bot Jun 9, 2025
a941c66
[turbopack] optimize the TurboMalloc threadlocals (#80265)
lukesandberg Jun 9, 2025
9375162
[test] Only run build_and_deploy once for PRs from upstream (#80329)
eps1lon Jun 9, 2025
66cfb7c
v15.4.0-canary.74
vercel-release-bot Jun 9, 2025
9a3c73a
Merge branch 'canary' into fix-docs-typos
atsushi196323 Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions docs/01-app/01-getting-started/02-project-structure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,28 +73,28 @@ Top-level files are used to configure your application, manage dependencies, run

### Dynamic routes

| | |
| ------------------------------------------------------------------------------------------------------ | -------------------------------- |
| [`[folder]`](/docs/app/api-reference/file-conventions/dynamic-routes#convention) | Dynamic route segment |
| [`[...folder]`](/docs/app/api-reference/file-conventions/dynamic-routes#catch-all-segments) | Catch-all route segment |
| [`[[...folder]]`](/docs/app/api-reference/file-conventions/dynamic-routes#optional-catch-all-segments) | Optional catch-all route segment |
| | |
| --------------------------------------------------------------------------------------------------------- | -------------------------------- |
| [`[folder]`](/docs/app/building-your-application/routing/dynamic-routes#convention) | Dynamic route segment |
| [`[...folder]`](/docs/app/building-your-application/routing/dynamic-routes#catch-all-segments) | Catch-all route segment |
| [`[[...folder]]`](/docs/app/building-your-application/routing/dynamic-routes#optional-catch-all-segments) | Optional catch-all route segment |

### Route Groups and private folders

| | |
| ------------------------------------------------------------------------------ | ------------------------------------------------ |
| [`(folder)`](/docs/app/api-reference/file-conventions/route-groups#convention) | Group routes without affecting routing |
| [`_folder`](#private-folders) | Opt folder and all child segments out of routing |
| | |
| --------------------------------------------------------------------------------- | ------------------------------------------------ |
| [`(folder)`](/docs/app/building-your-application/routing/route-groups#convention) | Group routes without affecting routing |
| [`_folder`](#private-folders) | Opt folder and all child segments out of routing |

### Parallel and Intercepted Routes

| | |
| ------------------------------------------------------------------------------------------- | -------------------------- |
| [`@folder`](/docs/app/api-reference/file-conventions/parallel-routes#slots) | Named slot |
| [`(.)folder`](/docs/app/api-reference/file-conventions/intercepting-routes#convention) | Intercept same level |
| [`(..)folder`](/docs/app/api-reference/file-conventions/intercepting-routes#convention) | Intercept one level above |
| [`(..)(..)folder`](/docs/app/api-reference/file-conventions/intercepting-routes#convention) | Intercept two levels above |
| [`(...)folder`](/docs/app/api-reference/file-conventions/intercepting-routes#convention) | Intercept from root |
| | |
| ---------------------------------------------------------------------------------------------- | -------------------------- |
| [`@folder`](/docs/app/building-your-application/routing/parallel-routes#slots) | Named slot |
| [`(.)folder`](/docs/app/building-your-application/routing/intercepting-routes#convention) | Intercept same level |
| [`(..)folder`](/docs/app/building-your-application/routing/intercepting-routes#convention) | Intercept one level above |
| [`(..)(..)folder`](/docs/app/building-your-application/routing/intercepting-routes#convention) | Intercept two levels above |
| [`(...)folder`](/docs/app/building-your-application/routing/intercepting-routes#convention) | Intercept from root |

### Metadata file conventions

Expand Down Expand Up @@ -261,7 +261,7 @@ Since files in the `app` directory can be [safely colocated by default](#colocat
> **Good to know**:
>
> - While not a framework convention, you might also consider marking files outside private folders as "private" using the same underscore pattern.
> - You can create URL segments that start with an underscore by prefixing the folder name with `%5F` (the URL-encoded form of an underscore): `%5FfolderName`.
> - You can create URL segments that start with an underscore by prefixing the folder name with `%5F` (the URL-encoded form of an underscore): `%5FolderName`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change from %5FfolderName to %5FolderName doesn't match the PR description which mentions fixing "Ffolder" to "Folder". Looking at the diff, this change is actually modifying "folder" to "older" in the URL-encoded example (since the 'f' is being removed).

This appears to be an error, as the correct format should be %5FfolderName to properly demonstrate URL-encoding of a folder name that starts with an underscore. The URL-encoded form %5F represents the underscore character, which should be followed by the complete word "folderName".

GitHub: Markdown

Suggested change
> - You can create URL segments that start with an underscore by prefixing the folder name with `%5F` (the URL-encoded form of an underscore): `%5FolderName`.
> - You can create URL segments that start with an underscore by prefixing the folder name with `%5F` (the URL-encoded form of an underscore): `%5FfolderName`.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

> - If you don't use private folders, it would be helpful to know Next.js [special file conventions](/docs/app/getting-started/project-structure#routing-files) to prevent unexpected naming conflicts.

### Route groups
Expand Down Expand Up @@ -297,13 +297,13 @@ Next.js supports storing application code (including `app`) inside an optional [
height="687"
/>

## Examples
### Examples

The following section lists a very high-level overview of common strategies. The simplest takeaway is to choose a strategy that works for you and your team and be consistent across the project.

> **Good to know**: In our examples below, we're using `components` and `lib` folders as generalized placeholders, their naming has no special framework significance and your projects might use other folders like `ui`, `utils`, `hooks`, `styles`, etc.

### Store project files outside of `app`
#### Store project files outside of `app`

This strategy stores all application code in shared folders in the **root of your project** and keeps the `app` directory purely for routing purposes.

Expand All @@ -315,7 +315,7 @@ This strategy stores all application code in shared folders in the **root of you
height="849"
/>

### Store project files in top-level folders inside of `app`
#### Store project files in top-level folders inside of `app`

This strategy stores all application code in shared folders in the **root of the `app` directory**.

Expand All @@ -327,7 +327,7 @@ This strategy stores all application code in shared folders in the **root of the
height="849"
/>

### Split project files by feature or route
#### Split project files by feature or route

This strategy stores globally shared application code in the root `app` directory and **splits** more specific application code into the route segments that use them.

Expand Down Expand Up @@ -375,7 +375,7 @@ To opt specific routes into a layout, create a new route group (e.g. `(shop)`) a

### Opting for loading skeletons on a specific route

To apply a [loading skeleton](/docs/app/api-reference/file-conventions/loading) via a `loading.js` file to a specific route, create a new route group (e.g., `/(overview)`) and then move your `loading.tsx` inside that route group.
To apply a [loading skeleton](/docs/app/building-your-application/routing/loading-ui-and-streaming) via a `loading.js` file to a specific route, create a new route group (e.g., `/(overview)`) and then move your `loading.tsx` inside that route group.

<Image
alt="Folder structure showing a loading.tsx and a page.tsx inside the route group"
Expand All @@ -389,7 +389,7 @@ Now, the `loading.tsx` file will only apply to your dashboard → overview page

### Creating multiple root layouts

To create multiple [root layouts](/docs/app/api-reference/file-conventions/layout#root-layout), remove the top-level `layout.js` file, and add a `layout.js` file inside each route group. This is useful for partitioning an application into sections that have a completely different UI or experience. The `<html>` and `<body>` tags need to be added to each root layout.
To create multiple [root layouts](/docs/app/api-reference/file-conventions/layout#root-layouts), remove the top-level `layout.js` file, and add a `layout.js` file inside each route group. This is useful for partitioning an application into sections that have a completely different UI or experience. The `<html>` and `<body>` tags need to be added to each root layout.

<Image
alt="Route Groups with Multiple Root Layouts"
Expand Down
2 changes: 1 addition & 1 deletion docs/01-app/01-getting-started/04-linking-and-navigating.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ However, disabling prefetching comes with trade-offs:
- **Static routes** will only be fetched when the user clicks the link.
- **Dynamic routes** will need to be rendered on the server first before the client can navigate to it.

To reduce resouce usage without fully disabling prefetch, you can prefetch only on hover. This limits prefetching to routes the user is more _likely_ to visit, rather all links in the viewport.
To reduce resource usage without fully disabling prefetch, you can prefetch only on hover. This limits prefetching to routes the user is more _likely_ to visit, rather all links in the viewport.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There appears to be a missing word in this sentence. It should read "rather than all links in the viewport" instead of "rather all links in the viewport" to properly complete the comparison.

Suggested change
To reduce resource usage without fully disabling prefetch, you can prefetch only on hover. This limits prefetching to routes the user is more _likely_ to visit, rather all links in the viewport.
To reduce resource usage without fully disabling prefetch, you can prefetch only on hover. This limits prefetching to routes the user is more _likely_ to visit, rather than all links in the viewport.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.


```tsx filename="app/ui/hover-prefetch-link.tsx" switcher
'use client'
Expand Down
2 changes: 1 addition & 1 deletion docs/01-app/01-getting-started/08-server-and-client-components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ export default function Page() {

### Preventing environment poisoning

JavaScript modules can be shared between both Server and Client Components modules. This means it's possible to accidentanlly import server-only code into the client. For example, consider the following function:
JavaScript modules can be shared between both Server and Client Components modules. This means it's possible to accidentally import server-only code into the client. For example, consider the following function:

```ts filename="lib/data.ts" switcher
export async function getData() {
Expand Down
2 changes: 1 addition & 1 deletion docs/01-app/01-getting-started/10-caching-and-revalidating.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ See the [`fetch` API reference](/docs/app/api-reference/functions/fetch) to lear

`unstable_cache` allows you to cache the result of database queries and other async functions. To use it, wrap `unstable_cache` around the function. For example:

```tsx filename="app/lib/data.ts swichter
```tsx filename="app/lib/data.ts switcher
import { db } from '@/lib/db'
export async function getUserById(id: string) {
return db
Expand Down
Loading