next.js
bdd41bbc - Docs: Updating guides on PPR and ISR (#81307)

Commit
173 days ago
Docs: Updating guides on PPR and ISR (#81307) The PR fixes issues in two different guides. ### PPR In PPR, the code for jsx and tsx versions should use the language switcher. Currently, these are displayed below each other in the guide which seems unintentional. ### ISR This change fixes multiple issues: **fixes in the example:** the example currently does not match the text below (_Here's how this example works:_). It says: > If /blog/26 is requested, Next.js will generate and cache this page on-demand that is of course not correct because there are only 25 blog posts returned from the API. No blog post data is returned for `/blog/26`, making this example wrong and confusing. By slicing the posts and supplying only 24 of 25 blog posts for static generation during the build process, the guide becomes much more explicit - the 25th blog post can be used for inspecting the workings of the on-the-fly generation and caching. Turning `dynamicParams` to `false` or `true`, one can now truly test this behaviour with the 25th blog. Second, the same example in Pages Router docs includes: > return { paths, fallback: false } In this case, again, this part below: > If /blog/26 is requested, Next.js will generate and cache this page on-demand is incorrect. When setting `fallback` to `false`, the page is never generated on-demand and returns 404 instead as there is no 26th blog post in the fetched data. So the fix changes the value of `fallback` to `blocking`, to mirror the App Router's `dynamicParams` value in the guide. This makes is more consistent and, more importantly, reproducible example. **clarifying the on-demand section:** The sections dedicated to **on-demand revalidation** do not currently mention that revalidation works differently from the time-based one. One may assume the first request after on-demand revalidation returns stale data (just like time-based). But that's not true, the next request after on-demand revalidation (with Server Actions for example) generates the content on-the-fly and returns fresh data right away. It wasn't clear to me so I tested it myself and was surprised (and happy) that it is this smart. I think it's very important to clarify this distinction in the guide. ----- I hope this makes sense. I'm quite responsive these days and will change it based on your feedback (if any). Thanks! <!-- 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 # --> --------- Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
Author
Parents
Loading