Skip to content

Commit

Permalink
Fix some broken links for the vue docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fulopkovacs committed May 12, 2024
1 parent ddecce7 commit 8acdad3
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/framework/react/guides/important-defaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
2 changes: 1 addition & 1 deletion docs/framework/react/guides/mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/guides/network-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/plugins/createSyncStoragePersister.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/vue/guides/ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
2 changes: 1 addition & 1 deletion docs/framework/vue/guides/suspense.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/framework/vue/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/vue/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
2 changes: 1 addition & 1 deletion docs/framework/vue/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<script setup>
Expand Down

0 comments on commit 8acdad3

Please sign in to comment.