Update On-demand revalidation docs

[dmgawel]

Remove mention about revalidatePath not being supported in the App Router. It was introduced in #460.

Summary by CodeRabbit

• Documentation
  • Updated on-demand revalidation documentation to clarify Next.js’ page and fetch call revalidation capabilities.
  • Removed references to previous limitations, ensuring the instructions now accurately reflect the current functionality.
  • Introduced additional documentation content to further support user understanding of these enhancements.

[changeset-bot]

🦋 Changeset detected

Latest commit: 9883fff

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Walkthrough

This pull request introduces a new documentation file and updates an existing one. The new file (.changeset/twelve-items-allow.md) provides a patch for the @repo/cache-handler-docs with updated on-demand revalidation details. The existing documentation file (docs/cache-handler-docs/src/app/usage/on-demand-revalidation/page.mdx) has been modified by removing a specific limitation related to the @neshca/cache-handler Pages Router, shifting the focus to a generalized description of Next.js's on-demand revalidation capability.

Changes

File(s)	Summary
.changeset/twelve-items-allow.md	Added a new documentation file patching @repo/cache-handler-docs with updates regarding on-demand revalidation.
docs/cache-handler-docs/src/app/usage/on-demand-revalidation/page.mdx	Removed the limitation note for the @neshca/cache-handler feature by deleting mention of its exclusive usage with the Pages Router, generalizing the content.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/cache-handler-docs/src/app/usage/on-demand-revalidation/page.mdx (1)

23-27: Consider clarifying the revalidatePath caveat.

While the caveat correctly explains that revalidatePath does not immediately revalidate the cached fetch result, consider adding a brief note about what happens on subsequent requests (e.g., whether stale data is served until revalidation completes) to further aid reader understanding.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~27-~27: You might be missing the article “the” here.
Context: ...nually mark the cache as revalidated in Handler's revalidateTag method. Later in the ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9144fc5 and 9883fff.

📒 Files selected for processing (2)

• .changeset/twelve-items-allow.md (1 hunks)
• docs/cache-handler-docs/src/app/usage/on-demand-revalidation/page.mdx (1 hunks)

🔇 Additional comments (4)

.changeset/twelve-items-allow.md (2)

1-3: Correct YAML front matter for changeset.

The metadata specifying a patch update for the @repo/cache-handler-docs package is correctly formatted and follows the changeset conventions.

---

5-6: Clear changeset message.

The commit message "Update On-demand revalidation docs" is concise and aligns with the PR title and objectives.

docs/cache-handler-docs/src/app/usage/on-demand-revalidation/page.mdx (2)

3-3: Updated revalidation description.

The revised line now clearly states that Next.js provides a way to revalidate a page or a fetch result on demand, reflecting the updated support now available in the App Router.

---

17-21: Improved App Router documentation.

The section now correctly highlights that the App Router supports both revalidatePath and revalidateTag functions, thereby removing the previous limitation. This update aligns well with the current capabilities of Next.js.