docs: improve unstable_cache documentation with clearer example #86343
Conversation
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
Member
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR simplifies the unstable_cache documentation by replacing a complex example that involved params handling with a more straightforward "Get Posts" scenario using mock data.
- Removed the params-based user fetching example
- Added a simpler posts list example with mock data that clearly demonstrates the caching mechanism
- Improved code consistency between TypeScript and JavaScript examples
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Author
|
Happy to refine the example if you prefer a different structure, naming, or level of detail. |
chandraiwayan
approved these changes
Nov 20, 2025
Rezakarimzadeh98
force-pushed
the
docs/improve-unstable-cache-example
branch
from
03b17a6 to
d10ed21
Compare
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?
I updated the example in the
unstable_cachedocumentation to be simpler and more focused.Why?
The previous example was a bit complex as it mixed
paramshandling with the caching logic. It wasn't immediately clear for beginners howunstable_cacheworks in isolation.How?
I replaced the example with a straightforward "Get Posts" scenario that uses mock data. This demonstrates the caching mechanism clearly without the distraction of other Next.js features.