docs: link updateTag from cacheTag reference#92379
Open
aurorascharff wants to merge 2 commits intocanaryfrom
Open
docs: link updateTag from cacheTag reference#92379aurorascharff wants to merge 2 commits intocanaryfrom
aurorascharff wants to merge 2 commits intocanaryfrom
Conversation
Add updateTag to related links and a Good to know bullet pointing to the updateTag API and Differences from revalidateTag, without duplicating examples. Made-with: Cursor
nextjs-bot
added
created-by: Next.js DevEx team
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the cacheTag API reference by making the alternative invalidation primitive (updateTag) more discoverable, helping readers understand when to choose immediate expiry vs stale-while-revalidate behavior.
Changes:
- Added
updateTagto thecacheTagpage’s Related links. - Added a Good to know bullet pointing readers to
updateTagfor read-your-own-writes / immediate expiry, with a deep link to the comparison section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
updateTagto thecacheTagAPI page: a Related link and a Good to know bullet that explains when to use it (read-your-own-writes / immediate expiry) and points to Differences fromrevalidateTag.Why?
The bundled
cacheTagdoc only walked throughrevalidateTag, so the two-API invalidation model was easy to miss. This keeps existingrevalidateTagwording and examples unchanged and adds a minimal pointer toupdateTagwithout duplicating its full reference.How?
related.links: includeapp/api-reference/functions/updateTag.## Good to know: one imperative bullet + deep link to the comparison section on theupdateTagpage.PR checklist (Improving Documentation)
pnpm prettier-fixif needed.Made with Cursor