-
Notifications
You must be signed in to change notification settings - Fork 29.5k
[backport] docs: september improvements and fixes #83997
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.
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was easier than needing to modify `package.json` or similar. Thank you! _(Hello from the otheeerr siiiiiiiddeeee 🎶)_
### What? This PR fixes a missing comma in the function parameter in `03-api-reference/03-file-conventions/layout.mdx`. The comma between `children` and `params` parameters was missing in the documentation example, showing incorrect syntax. ### Why? The missing comma in the documentation example shows invalid JavaScript/TypeScript syntax. ### How? - Added missing comma after `children` parameter . **Before:** ```tsx filename="app/dashboard/[team]/layout.tsx" switcher export default async function Layout({ children params, }: { ``` **After:** ```tsx filename="app/dashboard/[team]/layout.tsx" switcher export default async function Layout({ children, params, }: { children: React.ReactNode ```
We accidentally removed the documentation for `as` prop in Pages Router `next/link`. Closes: https://linear.app/vercel/issue/DOC-3140/add-missing-props-as-to-nextlink-reference-page
This link was to the current page, which isn't very useful. Link to the getting started page (https://nextjs.org/docs/app/getting-started/route-handlers-and-middleware#middleware) instead
[`next-intlayer`](https://intlayer.org/doc/environment/nextjs) is an i18n library that adopts a per-component approach to manage multilingual content in a next.js application. ### Changes - Fix doc related to page-router documentation, - And add App Router realted doc. Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
Adds the `bun add server-only` command to the data security guide. This change adds the missing Bun package manager example to the `docs/01-app/02-guides/data-security.mdx` file, ensuring consistency with other documentation sections. Fixes #83734 Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
Make a couple of clarifications: - type resolved by the helpers - ways to narrow down to a narrower union --------- Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com> Co-authored-by: Rich Haines <hello@richardhaines.dev>
Ref: #83481 Closes: https://linear.app/vercel/issue/DOC-5070/mutating-cookies-invalidates-router-cache Making sure those using cookies in server actions, know that the server tree is re-rendered and merged with the current client tree.
…#83665) fix _nextjsDevtools csp error which happens in development environment after enabling csp and following the current documents. Full Error: - Refused to apply inline style because it violates the following Content Security Policy directive: "style-src 'self' 'nonce-YmYyMTZmYTQtMzgxNy00ZjYwLWIwMGQtYjBmYjJjNGYzZWQ1' 'unsafe-inline'". Note that 'unsafe-inline' is ignored if either a hash or nonce value is present in the source list. <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
…3469) **Summary** This PR adds a note to the documentation clarifying the behavior when using external or internal URLs (API Routes) as image sources with Next.js Image Optimization. This change addresses issue #82610. **Details** - Added a note explaining that, for security reasons, request headers are not forwarded to API Routes or external URLs when Image Optimization is used. - Documented that if image data requires authentication, the `unoptimized` property should be considered to disable Image Optimization. **Why** Users may be confused when trying to load images from endpoints that require authentication. This clarification helps developers understand the limitation and how to handle such cases. **References** - [Vercel Changelog: CVE-2025-57752](https://vercel.com/changelog/cve-2025-57752) - [Next.js GitHub Issue #82703](#82703) --- resolves #82610 --------- Co-authored-by: Joseph <sephxd1234@gmail.com> Co-authored-by: Steven <steven@ceriously.com>
Co-authored-by: Jiachi Liu <inbox@huozhi.im>
- I've seen `NextResponse.next({ headers });` where devs likely meant `NextResponse.next({ request: { headers } });` - for example #82937 - Explaining further `outputFileTracingIncludes-*` options --------- Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
<!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> I think the phrase "in the root of your project" is unclear and contradictory if we use `src` directory. https://nextjs.org/docs/app/api-reference/file-conventions/src-folder#:~:text=src/app%20or%20src/pages%20will%20be%20ignored%20if%20app%20or%20pages%20are%20present%20in%20the%20root%20directory. So This PR removes that phrase. --------- Co-authored-by: Joseph <sephxd1234@gmail.com> Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com> Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
…3166) <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> Updates the middleware version history marking node as stable as [announced in version 15.5](https://nextjs.org/blog/next-15-5#nodejs-middleware-stable) Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
In previous docs versions, while not explicitly stated, it was rather clearer that middleware has its own runtime. Also, people who have used bundle-analyzer would for example be familiar with the 3 bundles, or those who have worked with `next.config.js`/instrumentation would understand that there's some different runtimes at play going on there, but those who exclusively work with middleware might still miss on this detail. --------- Co-authored-by: JJ Kasper <jj@jjsweb.site>
This link was to the current page, which isn't very useful. Link to the getting started page (https://nextjs.org/docs/app/getting-started/route-handlers-and-middleware#middleware) instead
A few more improvements to typed routes and friends - showing usage of router methods from `next/navigation` - using Route in other data structures
Certain relative links were absolute, which renders them with the -> external arrow - might have been a decision per case, but AFAIK, this is only helpful for those links that are now redirecting to other content
Addressing `papercuts` found this month - Fixes: #83622
ztanner
approved these changes
Sep 19, 2025
Tests Passed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
created-by: Next.js DevEx team
PRs by the DX team.
Documentation
Related to Next.js' official documentation.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Collects a bunch of docs improvements and fixes.