Update On-demand revalidation docs
Remove mention about revalidatePath not being supported in the App Router. It was introduced in https://github.com/caching-tools/next-shared-cache/pull/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 detected
Latest commit: 9883ffffb71712d85b7cfecad6bdbaf3602055fe
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
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.
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai planto trigger planning for file edits and PR creation. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
@Oren-Exon unfortunately merging appears blocked for me, so feel free to merge and release the PR on your own 🙌