Skip to content

Commit 30dc3fd

Browse files
committed
docs(devtools): update the DevTools docs
1 parent d7eb2f4 commit 30dc3fd

File tree

2 files changed

+27
-13
lines changed

2 files changed

+27
-13
lines changed

packages/overmind-devtools-client/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ The port is displayed in the DevTools UI, under the "Devtool port" section in th
119119
If you're having connection issues:
120120

121121
1. **Cannot connect to WebSocket server**
122-
* Check if the server is running (you should see "WebSocket server running on port 3031" in the console)
122+
* Check if the server is running (you should see "Overmind DevTools WebSocket server running on port 3031" in the console)
123123
* Verify no other application is using the port
124124
* Try specifying a different port using the OV_DEV_PORT environment variable
125125

@@ -134,8 +134,10 @@ If you're having connection issues:
134134

135135
## Local Development
136136

137+
You can open Chrome DevTools from the application menu: Select **Application > Open Chrome DevTools**.
138+
137139
This package bundle (`bundle.js`) is further used by the companion "host" packages (mentioned before).
138140

139-
Hence, make sure you've built this package before development.
141+
Hence, make sure you've built this package before developing the related packages.
140142

141-
**HINT**: you can also use the devtools electron app for local development by running [overmind-devtools](../overmind-devtools/README.md).
143+
**HINT**: you can also use the DevTools Electron app for local development by running [overmind-devtools](../overmind-devtools/README.md).
Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,34 @@
1-
### Introduction
1+
# Overmind DevTools Electron
2+
3+
## Introduction
24

35
This package is one of three packages related to `overmind-devtools`.
46

57
If you're looking for a little deeper insight about these, please check [overmind-devtools-client](../overmind-devtools-client/README.md).
68

7-
### Local development
9+
## Usage
810

9-
**PREREQUISITE**: make sure you firstly [built](../overmind-devtools-client/README.md) devtools UI core so that it can be hosted by this package (electron application).
11+
For normal use, you can run the DevTools directly using npx:
1012

11-
Considering the above prerequisite is satisfied, run the following steps:
12-
1. Build the host:
1313
```sh
14-
npm run build
14+
npx overmind-devtools
1515
```
16-
2. Run the application:
16+
17+
## Local Development
18+
19+
**PREREQUISITE**: Make sure you first [built](../overmind-devtools-client/README.md) the devtools UI core.
20+
21+
Run the development version with:
22+
1723
```sh
18-
npm run prod
24+
npm start
1925
```
20-
3. Use `Application` tab and then clicking on `Open Chrome DevTools`:
2126

22-
![overmind-devtools-debugging](./docs/assets/overmind-devtools-debugging.png)
27+
This will:
28+
29+
1. Build the DevTools electron app
30+
2. Launch the Electron app with Chrome DevTools open for debugging
31+
32+
You can also open Chrome DevTools from the application menu: Select **Application > Open Chrome DevTools**.
33+
34+
![overmind-devtools-debugging](./docs/assets/overmind-devtools-debugging.png)

0 commit comments

Comments
 (0)