Merge pull request #20 from TanStack/chore/doc-update

chore: update doc config

Author: AlemTuzlak

docs/config.json

@@ -8,27 +8,14 @@
   "sections": [
     {
       "label": "Getting Started",
-      "children": [
-        {
-          "label": "Overview",
-          "to": "overview"
-        },
-        {
-          "label": "Quick Start",
-          "to": "quick-start"
-        },
-        {
-          "label": "Installation",
-          "to": "installation"
-        }
-      ],
+      "children": [],
       "frameworks": [
         {
           "label": "react",
           "children": [
             {
               "label": "React Adapter",
-              "to": "framework/react/adapter"
+              "to": "framework/react/basic-setup"
             }
           ]
         },
@@ -37,16 +24,29 @@
           "children": [
             {
               "label": "Solid Adapter",
-              "to": "framework/solid/adapter"
+              "to": "framework/solid/basic-setup"
             }
           ]
         }
       ]
     },
     {
       "label": "Guides",
-      "children": [
-        
+      "children": [],
+      "frameworks": [
+        {
+          "label": "react",
+          "children": [
+            {
+              "label": "React Query Guide",
+              "to": "framework/react/guides/custom-plugins"
+            }
+          ]
+        },
+        {
+          "label": "solid",
+          "children": []
+        }
       ]
     },
     {
@@ -103,4 +103,4 @@
       ]
     }
   ]
-}
+}

docs/framework/solid/reference/functions/tanstackdevtools.md

@@ -11,7 +11,7 @@ title: TanstackDevtools
 function TanstackDevtools(__namedParameters): Element
 ```
 
-Defined in: [devtools.tsx:91](https://github.com/TanStack/devtools/blob/main/packages/solid-devtools/src/devtools.tsx#L91)
+Defined in: [devtools.tsx:96](https://github.com/TanStack/devtools/blob/main/packages/solid-devtools/src/devtools.tsx#L96)
 
 ## Parameters
 

docs/framework/solid/reference/type-aliases/tanstackdevtoolssolidplugin.md

@@ -11,7 +11,7 @@ title: TanStackDevtoolsSolidPlugin
 type TanStackDevtoolsSolidPlugin = Omit<TanStackDevtoolsPlugin, "render" | "name"> & object;
 ```
 
-Defined in: [devtools.tsx:20](https://github.com/TanStack/devtools/blob/main/packages/solid-devtools/src/devtools.tsx#L20)
+Defined in: [devtools.tsx:21](https://github.com/TanStack/devtools/blob/main/packages/solid-devtools/src/devtools.tsx#L21)
 
 ## Type declaration
 

docs/reference/classes/tanstackdevtoolscore.md

@@ -7,7 +7,7 @@ title: TanStackDevtoolsCore
 
 # Class: TanStackDevtoolsCore
 
-Defined in: [core.tsx:39](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L39)
+Defined in: [devtools/src/core.tsx:42](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L42)
 
 ## Constructors
 
@@ -17,7 +17,7 @@ Defined in: [core.tsx:39](https://github.com/TanStack/devtools/blob/main/package
 new TanStackDevtoolsCore(init): TanStackDevtoolsCore
 ```
 
-Defined in: [core.tsx:48](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L48)
+Defined in: [devtools/src/core.tsx:53](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L53)
 
 #### Parameters
 
@@ -37,7 +37,7 @@ Defined in: [core.tsx:48](https://github.com/TanStack/devtools/blob/main/package
 mount<T>(el): void
 ```
 
-Defined in: [core.tsx:56](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L56)
+Defined in: [devtools/src/core.tsx:62](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L62)
 
 #### Type Parameters
 
@@ -61,7 +61,7 @@ Defined in: [core.tsx:56](https://github.com/TanStack/devtools/blob/main/package
 setConfig(config): void
 ```
 
-Defined in: [core.tsx:87](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L87)
+Defined in: [devtools/src/core.tsx:94](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L94)
 
 #### Parameters
 
@@ -81,7 +81,7 @@ Defined in: [core.tsx:87](https://github.com/TanStack/devtools/blob/main/package
 unmount(): void
 ```
 
-Defined in: [core.tsx:79](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L79)
+Defined in: [devtools/src/core.tsx:85](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L85)
 
 #### Returns
 

docs/reference/index.md

@@ -13,6 +13,7 @@ title: "@tanstack/devtools"
 
 ## Interfaces
 
+- [ClientEventBusConfig](interfaces/clienteventbusconfig.md)
 - [TanStackDevtoolsInit](interfaces/tanstackdevtoolsinit.md)
 - [TanStackDevtoolsPlugin](interfaces/tanstackdevtoolsplugin.md)
 

docs/reference/interfaces/clienteventbusconfig.md

@@ -0,0 +1,48 @@
+---
+id: ClientEventBusConfig
+title: ClientEventBusConfig
+---
+
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
+# Interface: ClientEventBusConfig
+
+Defined in: event-bus/dist/esm/client/client.d.ts:1
+
+## Properties
+
+### connectToServerBus?
+
+```ts
+optional connectToServerBus: boolean;
+```
+
+Defined in: event-bus/dist/esm/client/client.d.ts:6
+
+Optional flag to indicate if the devtools server event bus is available to connect to.
+This is used to determine if the devtools can connect to the server for real-time event streams.
+
+***
+
+### debug?
+
+```ts
+optional debug: boolean;
+```
+
+Defined in: event-bus/dist/esm/client/client.d.ts:10
+
+Optional flag to enable debug mode for the event bus.
+
+***
+
+### port?
+
+```ts
+optional port: number;
+```
+
+Defined in: event-bus/dist/esm/client/client.d.ts:15
+
+Optional port to connect to the devtools server event bus.
+Defaults to 42069.

docs/reference/interfaces/tanstackdevtoolsinit.md

@@ -7,7 +7,7 @@ title: TanStackDevtoolsInit
 
 # Interface: TanStackDevtoolsInit
 
-Defined in: [core.tsx:10](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L10)
+Defined in: [devtools/src/core.tsx:12](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L12)
 
 ## Properties
 
@@ -25,21 +25,31 @@ optional config: Partial<{
 }>;
 ```
 
-Defined in: [core.tsx:16](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L16)
+Defined in: [devtools/src/core.tsx:18](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L18)
 
 Configuration for the devtools shell. These configuration options are used to set the
 initial state of the devtools when it is started for the first time. Afterwards,
 the settings are persisted in local storage and changed through the settings panel.
 
 ***
 
+### eventBusConfig?
+
+```ts
+optional eventBusConfig: ClientEventBusConfig;
+```
+
+Defined in: [devtools/src/core.tsx:39](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L39)
+
+***
+
 ### plugins?
 
 ```ts
 optional plugins: TanStackDevtoolsPlugin[];
 ```
 
-Defined in: [core.tsx:36](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L36)
+Defined in: [devtools/src/core.tsx:38](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/core.tsx#L38)
 
 Array of plugins to be used in the devtools.
 Each plugin has a `render` function that gives you the dom node to mount into

docs/reference/interfaces/tanstackdevtoolsplugin.md

@@ -7,7 +7,7 @@ title: TanStackDevtoolsPlugin
 
 # Interface: TanStackDevtoolsPlugin
 
-Defined in: [context/devtools-context.tsx:15](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L15)
+Defined in: [devtools/src/context/devtools-context.tsx:14](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L14)
 
 ## Properties
 
@@ -17,7 +17,7 @@ Defined in: [context/devtools-context.tsx:15](https://github.com/TanStack/devtoo
 optional id: string;
 ```
 
-Defined in: [context/devtools-context.tsx:47](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L47)
+Defined in: [devtools/src/context/devtools-context.tsx:46](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L46)
 
 Unique identifier for the plugin.
 If not provided, it will be generated based on the name.
@@ -30,7 +30,7 @@ If not provided, it will be generated based on the name.
 name: string | (el) => void;
 ```
 
-Defined in: [context/devtools-context.tsx:42](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L42)
+Defined in: [devtools/src/context/devtools-context.tsx:41](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L41)
 
 Name to be displayed in the devtools UI.
 If a string, it will be used as the plugin name.
@@ -65,7 +65,7 @@ or
 render: (el) => void;
 ```
 
-Defined in: [context/devtools-context.tsx:61](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L61)
+Defined in: [devtools/src/context/devtools-context.tsx:60](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L60)
 
 Render the plugin UI by using the provided element. This function will be called
 when the plugin tab is clicked and expected to be mounted.

docs/reference/type-aliases/tanstackdevtoolsconfig.md

@@ -11,4 +11,4 @@ title: TanStackDevtoolsConfig
 type TanStackDevtoolsConfig = DevtoolsStore["settings"];
 ```
 
-Defined in: [context/devtools-context.tsx:125](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L125)
+Defined in: [devtools/src/context/devtools-context.tsx:124](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/context/devtools-context.tsx#L124)

docs/reference/variables/plugin_container_id.md

@@ -11,4 +11,4 @@ title: PLUGIN_CONTAINER_ID
 const PLUGIN_CONTAINER_ID: "plugin-container" = 'plugin-container';
 ```
 
-Defined in: [constants.ts:1](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/constants.ts#L1)
+Defined in: [devtools/src/constants.ts:1](https://github.com/TanStack/devtools/blob/main/packages/devtools/src/constants.ts#L1)