Open
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
|
@shuding are we good to merge? |
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
2 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.
This pull request adds comprehensive documentation for the SWR (stale-while-revalidate) React data fetching library, including an overview, API reference, troubleshooting guide, and migration notes. The documentation is organized to help developers quickly understand core usage, configuration, advanced patterns, and common issues when working with SWR.
New Documentation Added:
General Overview and Quick Reference:
SKILL.mdproviding a summary of SWR, quick usage examples for all major hooks (useSWR,useSWRMutation,useSWRInfinite,useSWRSubscription,useSWRImmutable), key concepts, and links to further references.API Reference:
references/api.mddetailing all SWR hooks, configuration options, mutation/infinite loading settings, key and response types, cache API, and utility functions likemutate,preload, andunstable_serialize.Troubleshooting and Migration:
references/troubleshooting.mdwith solutions for common issues (unexpected revalidation, stale data, SSR/TypeScript/performance issues, infinite loops) and a migration guide from SWR v1 to v2, highlighting key API changes and usage patterns.