diff --git a/docs/framework/react/guides/important-defaults.md b/docs/framework/react/guides/important-defaults.md index 27e89ba519..66c2b73941 100644 --- a/docs/framework/react/guides/important-defaults.md +++ b/docs/framework/react/guides/important-defaults.md @@ -38,7 +38,7 @@ If you see a refetch that you are not expecting, it is likely because you just f Have a look at the following articles from our Community Resources for further explanations of the defaults: -- [Practical React Query](../community/tkdodos-blog#1-practical-react-query) -- [React Query as a State Manager](../community/tkdodos-blog#10-react-query-as-a-state-manager) +- [Practical React Query](../../../../framework/react/community/tkdodos-blog#1-practical-react-query) +- [React Query as a State Manager](../../../../framework/react/community/tkdodos-blog#10-react-query-as-a-state-manager) [//]: # 'Materials' diff --git a/docs/framework/react/guides/mutations.md b/docs/framework/react/guides/mutations.md index c277947efc..87bc4c8a00 100644 --- a/docs/framework/react/guides/mutations.md +++ b/docs/framework/react/guides/mutations.md @@ -340,7 +340,7 @@ queryClient.resumePausedMutations() ### Persisting Offline mutations -If you persist offline mutations with the [persistQueryClient plugin](../../plugins/persistQueryClient), mutations cannot be resumed when the page is reloaded unless you provide a default mutation function. +If you persist offline mutations with the [persistQueryClient plugin](../../../../framework/react/plugins/persistQueryClient), mutations cannot be resumed when the page is reloaded unless you provide a default mutation function. This is a technical limitation. When persisting to an external storage, only the state of mutations is persisted, as functions cannot be serialized. After hydration, the component that triggers the mutation might not be mounted, so calling `resumePausedMutations` might yield an error: `No mutationFn found`. diff --git a/docs/framework/react/guides/network-mode.md b/docs/framework/react/guides/network-mode.md index d8f06c9228..d0a6a74bcb 100644 --- a/docs/framework/react/guides/network-mode.md +++ b/docs/framework/react/guides/network-mode.md @@ -37,7 +37,7 @@ In those situations, the first fetch might succeed because it comes from an offl ## Devtools -The [TanStack Query Devtools](../../../../framework/react/guides/devtools) will show Queries in a `paused` state if they would be fetching, but there is no network connection. There is also a toggle button to _Mock offline behavior_. Please note that this button will _not_ actually mess with your network connection (you can do that in the browser devtools), but it will set the [OnlineManager](../../../../reference/onlineManager) in an offline state. +The [TanStack Query Devtools](../../../../framework/react/devtools) will show Queries in a `paused` state if they would be fetching, but there is no network connection. There is also a toggle button to _Mock offline behavior_. Please note that this button will _not_ actually mess with your network connection (you can do that in the browser devtools), but it will set the [OnlineManager](../../../../reference/onlineManager) in an offline state. ## Signature diff --git a/docs/framework/react/plugins/createSyncStoragePersister.md b/docs/framework/react/plugins/createSyncStoragePersister.md index e4f44b73db..2e58b2aa05 100644 --- a/docs/framework/react/plugins/createSyncStoragePersister.md +++ b/docs/framework/react/plugins/createSyncStoragePersister.md @@ -27,7 +27,7 @@ yarn add @tanstack/query-sync-storage-persister @tanstack/react-query-persist-cl - Import the `createSyncStoragePersister` function - Create a new syncStoragePersister -- Pass it to the [`persistQueryClient`](./plugins/persistQueryClient) function +- Pass it to the [`persistQueryClient`](../../plugins/persistQueryClient) function ```tsx import { persistQueryClient } from '@tanstack/react-query-persist-client' diff --git a/docs/framework/vue/guides/ssr.md b/docs/framework/vue/guides/ssr.md index 97896c676a..e826b295e6 100644 --- a/docs/framework/vue/guides/ssr.md +++ b/docs/framework/vue/guides/ssr.md @@ -230,6 +230,6 @@ In case you are creating the `QueryClient` for every request, Vue Query creates On the server, `cacheTime` defaults to `Infinity` which disables manual garbage collection and will automatically clear memory once a request has finished. If you are explicitly setting a non-Infinity `cacheTime` then you will be responsible for clearing the cache early. -To clear the cache after it is not needed and to lower memory consumption, you can add a call to [`queryClient.clear()`](./reference/QueryClient#queryclientclear) after the request is handled and dehydrated state has been sent to the client. +To clear the cache after it is not needed and to lower memory consumption, you can add a call to [`queryClient.clear()`](../../../../reference/QueryClient#queryclientclear) after the request is handled and dehydrated state has been sent to the client. Alternatively, you can set a smaller `cacheTime`. diff --git a/docs/framework/vue/guides/suspense.md b/docs/framework/vue/guides/suspense.md index e6251545ef..5c06d2deb5 100644 --- a/docs/framework/vue/guides/suspense.md +++ b/docs/framework/vue/guides/suspense.md @@ -51,4 +51,4 @@ export default defineComponent({ ## Fetch-on-render vs Render-as-you-fetch -Out of the box, Vue Query in `suspense` mode works really well as a **Fetch-on-render** solution with no additional configuration. This means that when your components attempt to mount, they will trigger query fetching and suspend, but only once you have imported them and mounted them. If you want to take it to the next level and implement a **Render-as-you-fetch** model, we recommend implementing [Prefetching](./guides/prefetching) on routing callbacks and/or user interactions events to start loading queries before they are mounted and hopefully even before you start importing or mounting their parent components. +Out of the box, Vue Query in `suspense` mode works really well as a **Fetch-on-render** solution with no additional configuration. This means that when your components attempt to mount, they will trigger query fetching and suspend, but only once you have imported them and mounted them. If you want to take it to the next level and implement a **Render-as-you-fetch** model, we recommend implementing [Prefetching](../prefetching) on routing callbacks and/or user interactions events to start loading queries before they are mounted and hopefully even before you start importing or mounting their parent components. diff --git a/docs/framework/vue/installation.md b/docs/framework/vue/installation.md index 6a33b7a99e..e78708b4cd 100644 --- a/docs/framework/vue/installation.md +++ b/docs/framework/vue/installation.md @@ -15,7 +15,7 @@ $ pnpm add @tanstack/vue-query $ yarn add @tanstack/vue-query ``` -> Wanna give it a spin before you download? Try out the [basic](./examples/basic) example! +> Wanna give it a spin before you download? Try out the [basic](../examples/basic) example! Vue Query is compatible with Vue 2.x and 3.x diff --git a/docs/framework/vue/overview.md b/docs/framework/vue/overview.md index 91e3ed902c..31c8da66ff 100644 --- a/docs/framework/vue/overview.md +++ b/docs/framework/vue/overview.md @@ -11,6 +11,6 @@ replace: { 'React': 'Vue', 'react-query': 'vue-query' } ## You talked me into it, so what now? -- Learn Vue Query at your own pace with our amazingly thorough [Walkthrough Guide](./installation) and [API Reference](./reference/useQuery) +- Learn Vue Query at your own pace with our amazingly thorough [Walkthrough Guide](../installation) and [API Reference](../reference/useQuery) [//]: # 'Materials' diff --git a/docs/framework/vue/quick-start.md b/docs/framework/vue/quick-start.md index c9d8afac81..c10605fe16 100644 --- a/docs/framework/vue/quick-start.md +++ b/docs/framework/vue/quick-start.md @@ -7,7 +7,7 @@ replace: { 'React': 'Vue', 'react-query': 'vue-query' } [//]: # 'Example' -If you're looking for a fully functioning example, please have a look at our [basic codesandbox example](./examples/basic) +If you're looking for a fully functioning example, please have a look at our [basic codesandbox example](../examples/basic) ```vue