Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for v2.0 #325

Merged
merged 28 commits into from
Dec 9, 2022
Merged

Docs for v2.0 #325

merged 28 commits into from
Dec 9, 2022

Commits on Aug 24, 2022

  1. Empty commit for v2 branch

    koba04 committed Aug 24, 2022
    Configuration menu
    Copy the full SHA
    631726d View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    5647dac View commit details
    Browse the repository at this point in the history
  3. docs: add mutate filter functions documentation in v2 (#340)

    * Empty commit for v2 branch
    
    * docs: add mutate filter functions documentation in v2
    
    * remove the usage of cache.clear() and use mutate instead
    koba04 committed Aug 24, 2022
    Configuration menu
    Copy the full SHA
    e81afb7 View commit details
    Browse the repository at this point in the history

Commits on Aug 30, 2022

  1. docs: add preload API documentation in v2 (#336)

    * Empty commit for v2 branch
    
    * docs: add preload API documentation in v2
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * Update pages/docs/prefetching.en-US.md
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * apply suggestions to other languages
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Aug 30, 2022
    Configuration menu
    Copy the full SHA
    fa6488c View commit details
    Browse the repository at this point in the history
  2. docs: add DevTools page in v2 (#337)

    * Empty commit for v2 branch
    
    * docs: add DevTools documentation in v2
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * apply suggestions to other languages
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Aug 30, 2022
    Configuration menu
    Copy the full SHA
    f71822f View commit details
    Browse the repository at this point in the history
  3. docs: SWRConfig value as a function (#335)

    * Empty commit for v2 branch
    
    * docs: Nesting configurations with SWRConfig
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * Update pages/docs/global-configuration.en-US.md
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * apply suggestions to other languages
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Aug 30, 2022
    Configuration menu
    Copy the full SHA
    4c5b2b2 View commit details
    Browse the repository at this point in the history
  4. Fetcher no longer accepts multiple arguments in v2 (#326)

    * Fetcher no longer accepts multiple arguments in v2
    
    * Empty commit for v2 branch
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * Update pages/docs/arguments.en-US.md
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * apply suggestions to other languages
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Aug 30, 2022
    Configuration menu
    Copy the full SHA
    5a01793 View commit details
    Browse the repository at this point in the history
  5. docs: add an example for preload in effect (#345)

    * docs: add an example for preload in effects
    
    * Update pages/docs/prefetching.en-US.md
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * merge examples for inside React
    
    * Update pages/docs/prefetching.en-US.md
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * apply a suggestion
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Aug 30, 2022
    Configuration menu
    Copy the full SHA
    602e161 View commit details
    Browse the repository at this point in the history

Commits on Sep 4, 2022

  1. docs: add isLoading and keepPreviousData pages in v2 (#343)

    * docs: add the Return Values page
    
    * docs: add isLoading and keepPreviousData option
    
    * docs: fix header levels
    
    * docs: add a video for keepPreviousData
    
    * docs: move arguments page to next to return values page
    
    * docs: update diagrams for returning values
    
    * docs: update the performance document to add isLoading
    
    * docs: keep the list of return values in the options document
    
    * use isLoading instead of !data
    
    * translate options.md into Japanese
    
    * docs: add a detail link for keepPreviousData
    
    * tweak the description of isLoading
    
    * revert to move the arguments page
    
    * move the return values page into the advanced section
    
    * rename the Options page to API Options
    
    * fix links to the return values
    
    * fix a typo
    
    * add an excalidraw file for the state machine diagrams
    
    * rename the page from Return Values to Understanding SWR
    
    * rename the Options page to API
    
    * translate Understanding SWR into Japanese
    
    * tweak
    
    * change /docs/options links to /docs/api
    
    * Update pages/docs/advanced/meta.en-US.json
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * change the link of Understanding SWR
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Sep 4, 2022
    Configuration menu
    Copy the full SHA
    5567dd5 View commit details
    Browse the repository at this point in the history

Commits on Sep 12, 2022

  1. add documentations for useSWRMutation (#348)

    * reorganize the mutation page for useSWRMutation
    
    * write paramters and return values sections for mutation
    
    * docs: add examples of useSWRMutation
    
    * add an exmple to use useSWRMutation for loading data
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    afcfbba View commit details
    Browse the repository at this point in the history
  2. docs: add notes for Suspense on SSR and React v18 in SWR v2 (#334)

    * Empty commit for v2 branch
    
    * docs: add notes for Suspense on SSR and React v18
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * apply suggestions to other languages
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * update other language
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    9e5a5f5 View commit details
    Browse the repository at this point in the history

Commits on Sep 14, 2022

  1. sync and refine mutate page (#350)

    * sync the mutation page of other languages
    
    * move the return values section of mutate into the API section
    koba04 committed Sep 14, 2022
    Configuration menu
    Copy the full SHA
    d5da143 View commit details
    Browse the repository at this point in the history

Commits on Sep 20, 2022

  1. Note for the shape of keys in mutate filter functions (#353)

    add a note for the shape of keys in mutate filter functions
    koba04 committed Sep 20, 2022
    Configuration menu
    Copy the full SHA
    fe0ae55 View commit details
    Browse the repository at this point in the history

Commits on Sep 21, 2022

  1. make explicit the location of mutate (#354)

    * explicit the location of mutate
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * apply feedback to other languages
    
    * add more descriptiong to mutation
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Sep 21, 2022
    Configuration menu
    Copy the full SHA
    b12fd2c View commit details
    Browse the repository at this point in the history

Commits on Sep 24, 2022

  1. v2 blog post (#351)

    * add the v2 blog page
    
    * update the description
    
    * add the migration guide section
    
    * write more section for what's new
    
    * write changes of highlights
    
    * add demo videos in the v2 blog and links to the CodeSandbox
    
    * tweak
    
    * add braking changes for mutate multiple items
    
    * update description
    
    * add isMutating into the example for useSWRMutation
    
    * Apply suggestions from code review
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * Update pages/blog/swr-v2.en-US.mdx
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    
    * move the details of isLoading and isValidating to the Userstanding SWR page
    
    * tweak wording
    
    * add authors
    
    * add og image
    
    Co-authored-by: Jiachi Liu <inbox@huozhi.im>
    koba04 and huozhi committed Sep 24, 2022
    Configuration menu
    Copy the full SHA
    a910d81 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    c1d2a80 View commit details
    Browse the repository at this point in the history

Commits on Sep 25, 2022

  1. sync translations (#356)

    * sync the translation docs
    
    * fix Author's link
    
    * remove copy from a file name
    koba04 committed Sep 25, 2022
    Configuration menu
    Copy the full SHA
    dc28baf View commit details
    Browse the repository at this point in the history
  2. Merge branch 'main' into v2

    koba04 committed Sep 25, 2022
    Configuration menu
    Copy the full SHA
    511b36c View commit details
    Browse the repository at this point in the history

Commits on Sep 26, 2022

  1. fix: typos in v2 docs (#357)

    * fix: the hook name of useSWRMutation example
    
    * fix: optimisticData examples
    koba04 committed Sep 26, 2022
    Configuration menu
    Copy the full SHA
    f8a093e View commit details
    Browse the repository at this point in the history

Commits on Nov 22, 2022

  1. Add onDiscarded option (#371)

    add onDiscarded option
    koba04 committed Nov 22, 2022
    Configuration menu
    Copy the full SHA
    6babb6d View commit details
    Browse the repository at this point in the history
  2. V2 docs improvements (#361)

    * blog improvements
    
    * update
    
    * update blog post
    
    * update mutation
    
    * update
    shuding committed Nov 22, 2022
    Configuration menu
    Copy the full SHA
    646077f View commit details
    Browse the repository at this point in the history

Commits on Nov 28, 2022

  1. docs: change the build target in the v2 blogdocs: (#381)

    docs: change the build target in the v2 blog
    koba04 committed Nov 28, 2022
    Configuration menu
    Copy the full SHA
    fb49dbb View commit details
    Browse the repository at this point in the history
  2. Add functional rollbackOnError description (#377)

    * Add functional rollbackOnError description
    
    * fix typo
    huozhi committed Nov 28, 2022
    Configuration menu
    Copy the full SHA
    88eb9c2 View commit details
    Browse the repository at this point in the history

Commits on Dec 6, 2022

  1. Configuration menu
    Copy the full SHA
    f1ba18f View commit details
    Browse the repository at this point in the history
  2. docs: translate v2 updates in Japanese (#384)

    * docs: translate v2 updates into Japanese
    
    * tweak
    koba04 committed Dec 6, 2022
    Configuration menu
    Copy the full SHA
    f60df0b View commit details
    Browse the repository at this point in the history

Commits on Dec 8, 2022

  1. Configuration menu
    Copy the full SHA
    0ab2971 View commit details
    Browse the repository at this point in the history
  2. Update card and description for the v2 blog post (#388)

    update card and description
    shuding committed Dec 8, 2022
    Configuration menu
    Copy the full SHA
    0346914 View commit details
    Browse the repository at this point in the history
  3. Rename laggy ui to preserving previous state (#389)

    * Rename laggy ui to preserving previous state
    
    * fix
    huozhi committed Dec 8, 2022
    Configuration menu
    Copy the full SHA
    bd2f77e View commit details
    Browse the repository at this point in the history