Skip to content
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

docs: fix prefetching information #64039

Merged
merged 1 commit into from
Apr 4, 2024

Conversation

ztanner
Copy link
Member

@ztanner ztanner commented Apr 3, 2024

The docs make a distinction between prefetch behavior based on static/dynamic data but this is not how it's implemented. The correct heuristic is based on the prefetch prop. The original PR describing this behavior can be found in #48383.

This clarifies how the prefetch prop influences the invalidation period, and how loading.js influences the prefetch response.

Closes NEXT-2994

Copy link
Member Author

ztanner commented Apr 3, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ztanner and the rest of your teammates on Graphite Graphite

@ztanner ztanner marked this pull request as ready for review April 3, 2024 18:16
@ztanner ztanner requested review from a team as code owners April 3, 2024 18:16
@ztanner ztanner requested review from ismaelrumzan and StephDietz and removed request for a team April 3, 2024 18:16
Base automatically changed from 04-03-docs_fix_dynamic_searchParams_copy to canary April 3, 2024 18:22
@ztanner ztanner force-pushed the 04-03-docs_fix_prefetching_information branch from 33c906c to 616d5cc Compare April 3, 2024 18:23
@ztanner ztanner force-pushed the 04-03-docs_fix_prefetching_information branch from 616d5cc to 25e397b Compare April 4, 2024 14:54
@ztanner ztanner merged commit 00d9c58 into canary Apr 4, 2024
34 checks passed
@ztanner ztanner deleted the 04-03-docs_fix_prefetching_information branch April 4, 2024 14:57
epiloguess pushed a commit to epiloguess/next.js that referenced this pull request Apr 5, 2024
The docs make a distinction between prefetch behavior based on
static/dynamic data but this is not how it's implemented. The correct
heuristic is based on the `prefetch` prop. The original PR describing
this behavior can be found in vercel#48383.

This clarifies how the prefetch prop influences the invalidation period,
and how `loading.js` influences the prefetch response.

<!-- 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 #

-->


Closes NEXT-2994
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Next.js team PRs by the Next.js team. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants