Skip to content

Commit 101422e

Browse files
docs: correct local relative links (#973)
1 parent 8a6a2a2 commit 101422e

File tree

248 files changed

+1915
-2123
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

248 files changed

+1915
-2123
lines changed

docs/framework/angular/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ npm install @tanstack/angular-db
1111

1212
## Angular inject function
1313

14-
See the [Angular Functions Reference](../reference/index.md) to see the full list of functions available in the Angular Adapter.
14+
See the [Angular Functions Reference](./reference/index.md) to see the full list of functions available in the Angular Adapter.
1515

16-
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
16+
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).
1717

1818
## Basic Usage
1919

docs/framework/angular/reference/functions/injectLiveQuery.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angu
3737

3838
### Returns
3939

40-
[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
40+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
4141

4242
## Call Signature
4343

@@ -71,7 +71,7 @@ Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angu
7171

7272
### Returns
7373

74-
[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
74+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
7575

7676
## Call Signature
7777

@@ -95,7 +95,7 @@ Defined in: [index.ts:71](https://github.com/TanStack/db/blob/main/packages/angu
9595

9696
### Returns
9797

98-
[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
98+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
9999

100100
## Call Signature
101101

@@ -119,7 +119,7 @@ Defined in: [index.ts:74](https://github.com/TanStack/db/blob/main/packages/angu
119119

120120
### Returns
121121

122-
[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
122+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
123123

124124
## Call Signature
125125

@@ -143,7 +143,7 @@ Defined in: [index.ts:77](https://github.com/TanStack/db/blob/main/packages/angu
143143

144144
### Returns
145145

146-
[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
146+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
147147

148148
## Call Signature
149149

@@ -175,4 +175,4 @@ Defined in: [index.ts:80](https://github.com/TanStack/db/blob/main/packages/angu
175175

176176
### Returns
177177

178-
[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\>
178+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\>

docs/framework/angular/reference/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ title: "@tanstack/angular-db"
77

88
## Interfaces
99

10-
- [InjectLiveQueryResult](../interfaces/InjectLiveQueryResult.md)
10+
- [InjectLiveQueryResult](./interfaces/InjectLiveQueryResult.md)
1111

1212
## Functions
1313

14-
- [injectLiveQuery](../functions/injectLiveQuery.md)
14+
- [injectLiveQuery](./functions/injectLiveQuery.md)

docs/framework/react/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ npm install @tanstack/react-db
1111

1212
## React Hooks
1313

14-
See the [React Functions Reference](../reference/index.md) to see the full list of hooks available in the React Adapter.
14+
See the [React Functions Reference](./reference/index.md) to see the full list of hooks available in the React Adapter.
1515

16-
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
16+
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).
1717

1818
## Basic Usage
1919

docs/framework/react/reference/functions/useLiveInfiniteQuery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ without recreating the live query collection on each page change.
4040

4141
#### config
4242

43-
[`UseLiveInfiniteQueryConfig`](../../type-aliases/UseLiveInfiniteQueryConfig.md)\<`any`\>
43+
[`UseLiveInfiniteQueryConfig`](../type-aliases/UseLiveInfiniteQueryConfig.md)\<`any`\>
4444

4545
Configuration including pageSize and getNextPageParam
4646

4747
### Returns
4848

49-
[`UseLiveInfiniteQueryReturn`](../../type-aliases/UseLiveInfiniteQueryReturn.md)\<`any`\>
49+
[`UseLiveInfiniteQueryReturn`](../type-aliases/UseLiveInfiniteQueryReturn.md)\<`any`\>
5050

5151
Object with pages, data, and pagination controls
5252

@@ -141,7 +141,7 @@ Query function that defines what data to fetch. Must include `.orderBy()` for se
141141

142142
#### config
143143

144-
[`UseLiveInfiniteQueryConfig`](../../type-aliases/UseLiveInfiniteQueryConfig.md)\<`TContext`\>
144+
[`UseLiveInfiniteQueryConfig`](../type-aliases/UseLiveInfiniteQueryConfig.md)\<`TContext`\>
145145

146146
Configuration including pageSize and getNextPageParam
147147

@@ -153,7 +153,7 @@ Array of dependencies that trigger query re-execution when changed
153153

154154
### Returns
155155

156-
[`UseLiveInfiniteQueryReturn`](../../type-aliases/UseLiveInfiniteQueryReturn.md)\<`TContext`\>
156+
[`UseLiveInfiniteQueryReturn`](../type-aliases/UseLiveInfiniteQueryReturn.md)\<`TContext`\>
157157

158158
Object with pages, data, and pagination controls
159159

docs/framework/react/reference/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ title: "@tanstack/react-db"
77

88
## Type Aliases
99

10-
- [UseLiveInfiniteQueryConfig](../type-aliases/UseLiveInfiniteQueryConfig.md)
11-
- [UseLiveInfiniteQueryReturn](../type-aliases/UseLiveInfiniteQueryReturn.md)
12-
- [UseLiveQueryStatus](../type-aliases/UseLiveQueryStatus.md)
10+
- [UseLiveInfiniteQueryConfig](./type-aliases/UseLiveInfiniteQueryConfig.md)
11+
- [UseLiveInfiniteQueryReturn](./type-aliases/UseLiveInfiniteQueryReturn.md)
12+
- [UseLiveQueryStatus](./type-aliases/UseLiveQueryStatus.md)
1313

1414
## Functions
1515

16-
- [useLiveInfiniteQuery](../functions/useLiveInfiniteQuery.md)
17-
- [useLiveQuery](../functions/useLiveQuery.md)
18-
- [useLiveSuspenseQuery](../functions/useLiveSuspenseQuery.md)
19-
- [usePacedMutations](../functions/usePacedMutations.md)
16+
- [useLiveInfiniteQuery](./functions/useLiveInfiniteQuery.md)
17+
- [useLiveQuery](./functions/useLiveQuery.md)
18+
- [useLiveSuspenseQuery](./functions/useLiveSuspenseQuery.md)
19+
- [usePacedMutations](./functions/usePacedMutations.md)

docs/framework/solid/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ npm install @tanstack/solid-db
1111

1212
## Solid Primitives
1313

14-
See the [Solid Functions Reference](../reference/index.md) to see the full list of primitives available in the Solid Adapter.
14+
See the [Solid Functions Reference](./reference/index.md) to see the full list of primitives available in the Solid Adapter.
1515

16-
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
16+
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).
1717

1818
## Basic Usage
1919

docs/framework/solid/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ title: "@tanstack/solid-db"
77

88
## Functions
99

10-
- [useLiveQuery](../functions/useLiveQuery.md)
10+
- [useLiveQuery](./functions/useLiveQuery.md)

docs/framework/svelte/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ npm install @tanstack/svelte-db
1111

1212
## Svelte Utilities
1313

14-
See the [Svelte Functions Reference](../reference/index.md) to see the full list of utilities available in the Svelte Adapter.
14+
See the [Svelte Functions Reference](./reference/index.md) to see the full list of utilities available in the Svelte Adapter.
1515

1616
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
1717

docs/framework/vue/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ npm install @tanstack/vue-db
1111

1212
## Vue Composables
1313

14-
See the [Vue Functions Reference](../reference/index.md) to see the full list of composables available in the Vue Adapter.
14+
See the [Vue Functions Reference](./reference/index.md) to see the full list of composables available in the Vue Adapter.
1515

16-
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
16+
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).
1717

1818
## Basic Usage
1919

0 commit comments

Comments
 (0)