docs: add quick-reference tables to cache components migration guide#92972
Draft
docs: add quick-reference tables to cache components migration guide#92972
Conversation
Add a "Quick reference" section with four comparison tables: - Cache directives (use cache vs remote vs private) - cacheLife built-in profiles with timings - Revalidation/invalidation functions (updateTag vs revalidateTag vs revalidatePath) - Route segment config migration mapping Each table entry links to the relevant API reference docs. Also calls out the deprecated single-arg revalidateTag form and the updateTag vs revalidateTag distinction. Co-authored-by: Joseph <icyJoseph@users.noreply.github.com>
nextjs-bot
added
created-by: Next.js DevEx team
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
3 participants
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
Adds a Quick reference section at the top of the "Migrating to Cache Components" guide (
docs/01-app/02-guides/migrating-to-cache-components.mdx) with four concise comparison tables:'use cache'vs'use cache: remote'vs'use cache: private'(scope, storage, runtime API access, use case)cacheLifeprofiles — all built-in profiles withstale,revalidate,expiretimings and typical contentupdateTagvsrevalidateTagvsrevalidatePath(where callable, behavior, best use case)dynamic,revalidate,fetchCache, andruntimeWhy
Motivated by a DX friction run that identified these gaps:
updateTagvsrevalidateTagdistinction is consequential but only reachable by navigating through multiple doc pagesrevalidateTag(tag)compiles silently — easy to missEvery table entry cross-references the relevant API reference docs so readers can drill into details.
Slack Thread