docs: note PPR default in cacheComponents reference#92378
Open
aurorascharff wants to merge 2 commits intocanaryfrom
Open
docs: note PPR default in cacheComponents reference#92378aurorascharff wants to merge 2 commits intocanaryfrom
aurorascharff wants to merge 2 commits intocanaryfrom
Conversation
Add a Good to know callout before Navigation with Activity: cacheComponents enables PPR, replaces legacy experimental flags, and explains Partial Prerender in build output with links to Caching and the v16 upgrade guide. Made-with: Cursor
nextjs-bot
added
created-by: Next.js DevEx team
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a “Good to know” callout to the cacheComponents API reference to clarify that enabling cacheComponents: true implies Partial Prerendering (PPR) behavior (including ◐ (Partial Prerender) build output) and to point readers to relevant rendering and migration docs.
Changes:
- Add a callout explaining PPR is the default behavior when
cacheComponentsis enabled. - Clarify that legacy experimental PPR config/route segment config is superseded and link to rendering + upgrade guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - The [`cacheLife` function](/docs/app/api-reference/config/next-config-js/cacheLife) with `use cache` | ||
| - The [`cacheTag` function](/docs/app/api-reference/functions/cacheTag) | ||
|
|
||
| > **Good to know:** With `cacheComponents` enabled, Next.js uses **Partial Prerendering (PPR)** for the App Router. That replaces the older `experimental.ppr` config and `experimental_ppr` route segment, so `◐ (Partial Prerender)` in `next build` output is expected. Read [How rendering works](/docs/app/getting-started/caching#how-rendering-works) for how the static shell and streaming fit together. If you used experimental PPR on Next.js 15, follow [Partial Prerendering (PPR)](/docs/app/guides/upgrading/version-16#partial-prerendering-ppr) in the Version 16 upgrade guide when you migrate. |
There was a problem hiding this comment.
This file already uses a different callout label format later (> **Good to know**:). To keep the page consistent, consider aligning this new callout’s label punctuation with the existing one (or updating both to the repo-standard > **Good to know:**).
Match Good to know colon style with the Activity callout and split the PPR note into short blockquote paragraphs for readability. Made-with: Cursor
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Add a Good to know callout on the
cacheComponentsAPI reference, placed after the Usage list and before Navigation with Activity.Why?
Developers enabling
cacheComponents: truemay see routes built as partial prerenders (◐ (Partial Prerender)) without ever turning on a separate PPR flag. The Caching getting-started guide already explains PPR as the default with Cache Components; this surfaces the same idea on the config page people often open first, and points to migration context for Next.js 15 experimental PPR.How?
Single callout: PPR is used with the flag, legacy
experimental.ppr/experimental_pprare superseded,◐innext buildis expected, with links to How rendering works and Partial Prerendering (PPR) in the Version 16 upgrade guide.PR checklist (Improving Documentation)
pnpm prettier-fixlocally if CI flags anything.Made with Cursor