Skip to content

docs: link updateTag from cacheTag reference#92379

Merged
aurorascharff merged 9 commits into
canaryfrom
docs/cache-tag-link-updateTag
Apr 9, 2026
Merged

docs: link updateTag from cacheTag reference#92379
aurorascharff merged 9 commits into
canaryfrom
docs/cache-tag-link-updateTag

Conversation

@aurorascharff

Copy link
Copy Markdown
Contributor

What?

Add updateTag to the cacheTag API 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 from revalidateTag.

Why?

The bundled cacheTag doc only walked through revalidateTag, so the two-API invalidation model was easy to miss. This keeps existing revalidateTag wording and examples unchanged and adds a minimal pointer to updateTag without duplicating its full reference.

How?

  • related.links: include app/api-reference/functions/updateTag.
  • ## Good to know: one imperative bullet + deep link to the comparison section on the updateTag page.

PR checklist (Improving Documentation)

Made with Cursor

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 nextjs-bot added created-by: Next.js DevEx team PRs by the DX team. Documentation Related to Next.js' official documentation. labels Apr 5, 2026
@aurorascharff aurorascharff marked this pull request as ready for review April 5, 2026 10:21
Copilot AI review requested due to automatic review settings April 5, 2026 10:21

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 updateTag to the cacheTag page’s Related links.
  • Added a Good to know bullet pointing readers to updateTag for 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.

Comment thread docs/01-app/03-api-reference/04-functions/cacheTag.mdx Outdated
Comment thread docs/01-app/03-api-reference/04-functions/cacheTag.mdx Outdated
Address review by presenting both invalidation APIs (updateTag and
revalidateTag) upfront in the Usage section instead of only in a
Good to know footnote.

Made-with: Cursor
@aurorascharff aurorascharff requested review from icyJoseph and ijjk April 7, 2026 12:36
Comment thread docs/01-app/03-api-reference/04-functions/cacheTag.mdx Outdated
Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
Comment thread docs/01-app/03-api-reference/04-functions/cacheTag.mdx Outdated
Comment thread docs/01-app/03-api-reference/04-functions/cacheTag.mdx Outdated
Comment thread docs/01-app/03-api-reference/04-functions/cacheTag.mdx Outdated
@aurorascharff aurorascharff requested a review from icyJoseph April 8, 2026 20:13
Comment thread docs/01-app/03-api-reference/04-functions/cacheTag.mdx Outdated

@icyJoseph icyJoseph left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just left some nit

@aurorascharff aurorascharff removed the request for review from ijjk April 9, 2026 11:18
@aurorascharff aurorascharff merged commit 766467e into canary Apr 9, 2026
74 checks passed
@aurorascharff aurorascharff deleted the docs/cache-tag-link-updateTag branch April 9, 2026 11:33
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Apr 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

created-by: Next.js DevEx team PRs by the DX team. Documentation Related to Next.js' official documentation. locked

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants