Skip to content

Commit 487123d

Browse files
docs: fix typos, formatting, and broken links (#293)
* docs: fix typos and improve formatting in documentation * period * fix example links in custom-plugins guides --------- Co-authored-by: Alem Tuzlak <[email protected]>
1 parent 831cf4c commit 487123d

File tree

5 files changed

+8
-10
lines changed

5 files changed

+8
-10
lines changed

docs/configuration.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ The `config` object is mainly focused around user interaction with the devtools
3939

4040
```ts
4141
{ panelLocation: 'top' | 'bottom' }
42-
4342
```
4443

4544
- `openHotkey` - The hotkey set to open the devtools
@@ -64,14 +63,12 @@ type KeyboardKey = ModifierKey | (string & {});
6463

6564
```ts
6665
{ requireUrlFlag: boolean }
67-
6866
```
6967

7068
- `triggerImage` - The image used for the dev tools trigger
7169

7270
```ts
7371
{ triggerImage: string }
74-
7572
```
7673

7774
- `urlFlag` - The required flag that must be present in the url to enable devtools.
@@ -80,7 +77,7 @@ type KeyboardKey = ModifierKey | (string & {});
8077
{ urlFlag: string }
8178
```
8279

83-
The `eventBusConfig` is configuration for the back bone of the devtools, the ``, and accepts the following properties:
80+
The `eventBusConfig` is configuration for the back bone of the devtools, the `EventClient`, and accepts the following properties:
8481

8582
- `debug` - Enables debug mode for the EventBus
8683

@@ -138,13 +135,13 @@ Configuration for the `EventClient` is as follows
138135
- `pluginId` (required) - The plugin identifier used by the event bus to direct events to listeners
139136

140137
```ts
141-
{pluginId: string}
138+
{ pluginId: string }
142139
```
143140

144141
- `debug` - Enables debug mode for the EventClient
145142

146143
```ts
147-
{debug: boolean}
144+
{ debug: boolean }
148145
```
149146

150147
Put together the `EventClient` configuration looks like:

docs/framework/preact/guides/custom-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ TanStack devtools allows you to create your own custom plugins by emitting and l
77

88
## Prerequisite
99

10-
This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/preact/examples/custom-plugin).
10+
This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/preact/examples/custom-devtools).
1111

1212
This is our library code:
1313

docs/framework/react/guides/custom-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ TanStack devtools allows you to create your own custom plugins by emitting and l
77

88
## Prerequisite
99

10-
This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/react/examples/custom-plugin).
10+
This guide will walk you through a simple example where our library is a counter with a count history. A working example can be found in our [custom-plugin example](https://tanstack.com/devtools/latest/docs/framework/react/examples/custom-devtools).
1111

1212
This is our library code:
1313

docs/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Overview
33
id: overview
44
---
55

6-
TanStack Devtools is a framework-agnostic devtool for managing and debugging *devtool devtools*
6+
TanStack Devtools is a framework-agnostic devtool for managing and debugging *your devtools*.
77

88
We offer you all the tools you need to build and maintain your own devtools with ease.
99

docs/plugin-configuration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ id: plugin-configuration
99
You can configure TanStack Devtools plugins by passing them as an array to the `plugins` prop of the `TanStackDevtools` component.
1010

1111
Each plugin can have the following configuration options:
12-
- `render` (required) - A React component that renders the plugin's UI
12+
- `name` (required) - A name to be displayed in the devtools UI.
13+
- `render` (required) - A React component that renders the plugin's UI.
1314
- `defaultOpen` (optional) - A boolean that determines if the plugin panel is open by default (default: false).
1415
- `id` (optional) - A unique identifier for the plugin. If not provided, a random id will be generated.
1516

0 commit comments

Comments
 (0)