Merge branch 'main' into ci/sherif-ingnore-package

Author: TkDodo

docs/config.json

@@ -5,7 +5,70 @@
     "apiKey": "35bc6c51aa322700d1383e17c4f669f4",
     "indexName": "tanstackquery"
   },
-  "menu": [],
+  "menu": [
+    {
+      "label": "API Reference",
+      "children": [
+        {
+          "label": "QueryClient",
+          "to": "reference/QueryClient"
+        },
+        {
+          "label": "QueryCache",
+          "to": "reference/QueryCache"
+        },
+        {
+          "label": "MutationCache",
+          "to": "reference/MutationCache"
+        },
+        {
+          "label": "QueryObserver",
+          "to": "reference/QueryObserver"
+        },
+        {
+          "label": "InfiniteQueryObserver",
+          "to": "reference/InfiniteQueryObserver"
+        },
+        {
+          "label": "QueriesObserver",
+          "to": "reference/QueriesObserver"
+        },
+        {
+          "label": "focusManager",
+          "to": "reference/focusManager"
+        },
+        {
+          "label": "onlineManager",
+          "to": "reference/onlineManager"
+        },
+        {
+          "label": "notifyManager",
+          "to": "reference/notifyManager"
+        }
+      ]
+    },
+    {
+      "label": "ESLint",
+      "children": [
+        {
+          "label": "ESLint Plugin Query",
+          "to": "eslint/eslint-plugin-query"
+        },
+        {
+          "label": "Exhaustive Deps",
+          "to": "eslint/exhaustive-deps"
+        },
+        {
+          "label": "Stable Query Client",
+          "to": "eslint/stable-query-client"
+        },
+        {
+          "label": "No Rest Destructuring",
+          "to": "eslint/no-rest-destructuring"
+        }
+      ]
+    }
+  ],
   "frameworkMenus": [
     {
       "framework": "react",
@@ -302,27 +365,6 @@
             }
           ]
         },
-        {
-          "label": "ESLint",
-          "children": [
-            {
-              "label": "ESLint Plugin Query",
-              "to": "framework/react/eslint/eslint-plugin-query"
-            },
-            {
-              "label": "Exhaustive Deps",
-              "to": "framework/react/eslint/exhaustive-deps"
-            },
-            {
-              "label": "Stable Query Client",
-              "to": "framework/react/eslint/stable-query-client"
-            },
-            {
-              "label": "No Rest Destructuring",
-              "to": "framework/react/eslint/no-rest-destructuring"
-            }
-          ]
-        },
         {
           "label": "Plugins",
           "children": [
@@ -391,10 +433,7 @@
               "label": "useSuspenseQueries",
               "to": "framework/react/reference/useSuspenseQueries"
             },
-            {
-              "label": "QueryClient",
-              "to": "framework/react/reference/QueryClient"
-            },
+
             {
               "label": "QueryClientProvider",
               "to": "framework/react/reference/QueryClientProvider"
@@ -411,26 +450,6 @@
               "label": "infiniteQueryOptions",
               "to": "framework/react/reference/infiniteQueryOptions"
             },
-            {
-              "label": "QueryCache",
-              "to": "framework/react/reference/QueryCache"
-            },
-            {
-              "label": "MutationCache",
-              "to": "framework/react/reference/MutationCache"
-            },
-            {
-              "label": "QueryObserver",
-              "to": "framework/react/reference/QueryObserver"
-            },
-            {
-              "label": "InfiniteQueryObserver",
-              "to": "framework/react/reference/InfiniteQueryObserver"
-            },
-            {
-              "label": "QueriesObserver",
-              "to": "framework/react/reference/QueriesObserver"
-            },
             {
               "label": "QueryErrorResetBoundary",
               "to": "framework/react/reference/QueryErrorResetBoundary"
@@ -439,18 +458,6 @@
               "label": "useQueryErrorResetBoundary",
               "to": "framework/react/reference/useQueryErrorResetBoundary"
             },
-            {
-              "label": "focusManager",
-              "to": "framework/react/reference/focusManager"
-            },
-            {
-              "label": "onlineManager",
-              "to": "framework/react/reference/onlineManager"
-            },
-            {
-              "label": "notifyManager",
-              "to": "framework/react/reference/notifyManager"
-            },
             {
               "label": "hydration",
               "to": "framework/react/reference/hydration"
@@ -732,42 +739,6 @@
               "label": "useQueryClient",
               "to": "framework/vue/reference/useQueryClient"
             },
-            {
-              "label": "QueryClient",
-              "to": "framework/vue/reference/QueryClient"
-            },
-            {
-              "label": "QueryCache",
-              "to": "framework/vue/reference/QueryCache"
-            },
-            {
-              "label": "MutationCache",
-              "to": "framework/vue/reference/MutationCache"
-            },
-            {
-              "label": "QueryObserver",
-              "to": "framework/vue/reference/QueryObserver"
-            },
-            {
-              "label": "InfiniteQueryObserver",
-              "to": "framework/vue/reference/InfiniteQueryObserver"
-            },
-            {
-              "label": "QueriesObserver",
-              "to": "framework/vue/reference/QueriesObserver"
-            },
-            {
-              "label": "focusManager",
-              "to": "framework/vue/reference/focusManager"
-            },
-            {
-              "label": "notifyManager",
-              "to": "framework/vue/reference/notifyManager"
-            },
-            {
-              "label": "onlineManager",
-              "to": "framework/vue/reference/onlineManager"
-            },
             {
               "label": "hydration",
               "to": "framework/vue/reference/hydration"
@@ -967,6 +938,23 @@
               "to": "framework/angular/guides/does-this-replace-client-state"
             }
           ]
+        },
+        {
+          "label": "Examples",
+          "children": [
+            {
+              "label": "Simple",
+              "to": "framework/angular/examples/simple"
+            },
+            {
+              "label": "Basic",
+              "to": "framework/angular/examples/basic"
+            },
+            {
+              "label": "Default Query Function",
+              "to": "framework/angular/examples/default-query-function"
+            }
+          ]
         }
       ]
     }

docs/framework/react/eslint/eslint-plugin-query.md renamed to docs/eslint/eslint-plugin-query.md

@@ -3,7 +3,7 @@ id: caching
 title: Caching Examples
 ---
 
-> Please thoroughly read the [Important Defaults](../guides/important-defaults) before reading this guide
+> Please thoroughly read the [Important Defaults](./guides/important-defaults) before reading this guide
 
 ## Basic Example
 
@@ -23,7 +23,7 @@ Let's assume we are using the default `gcTime` of **5 minutes** and the default
 - A second instance of `injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodos })` initializes elsewhere.
   - Since the cache already has data for the `['todos']` key from the first query, that data is immediately returned from the cache.
   - The new instance triggers a new network request using its query function.
-    - Note that regardless of whether both `fetchTodos` query functions are identical or not, both queries' [`status`](../reference/injectQuery) are updated (including `isFetching`, `isPending`, and other related values) because they have the same query key.
+    - Note that regardless of whether both `fetchTodos` query functions are identical or not, both queries' [`status`](./reference/injectQuery) are updated (including `isFetching`, `isPending`, and other related values) because they have the same query key.
   - When the request completes successfully, the cache's data under the `['todos']` key is updated with the new data, and both instances are updated with the new data.
 - Both instances of the `injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodos })` query are destroyed and no longer in use.
   - Since there are no more active instances of this query, a garbage collection timeout is set using `gcTime` to delete and garbage collect the query (defaults to **5 minutes**).

docs/framework/react/eslint/exhaustive-deps.md renamed to docs/eslint/exhaustive-deps.md

@@ -40,4 +40,4 @@ export class TodosComponent {
 
 [//]: # 'Example2'
 
-You can wire up your invalidations to happen using any of the callbacks available in the [`injectMutation` function](../guides/mutations)
+You can wire up your invalidations to happen using any of the callbacks available in the [`injectMutation` function](./guides/mutations)

docs/framework/react/eslint/no-rest-destructuring.md renamed to docs/eslint/no-rest-destructuring.md

@@ -17,4 +17,4 @@ $ pnpm add @tanstack/angular-query-experimental
 $ yarn add @tanstack/angular-query-experimental
 ```
 
-> Wanna give it a spin before you download? Try out the [simple](../examples/angular/simple) or [basic](../examples/angular/basic) examples!
+> Wanna give it a spin before you download? Try out the [simple](./examples/simple) or [basic](./examples/basic) examples!

docs/framework/react/eslint/stable-query-client.md renamed to docs/eslint/stable-query-client.md

@@ -114,4 +114,4 @@ type Response = {
 
 ## You talked me into it, so what now?
 
-- Learn Angular Query at your own pace with our amazingly thorough [Walkthrough Guide](../installation) and [API Reference](../reference/injectQuery)
+- Learn Angular Query at your own pace with our amazingly thorough [Walkthrough Guide](./installation) and [API Reference](./reference/injectQuery)

docs/framework/angular/guides/caching.md

@@ -7,7 +7,7 @@ title: Quick Start
 
 [//]: # 'Example'
 
-If you're looking for a fully functioning example, please have a look at our [basic codesandbox example](../examples/angular/basic)
+If you're looking for a fully functioning example, please have a look at our [basic codesandbox example](./examples/basic)
 
 ### Provide the client to your App