Skip to content

Commit 61a2c82

Browse files
docs(website): added devtools docs
1 parent b29a636 commit 61a2c82

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import { getPackageWithVersion } from '../../templates'
2+
3+
export default () => [
4+
{
5+
fileName: 'package.json',
6+
code: `
7+
{
8+
"name": "my-app",
9+
"scripts": {
10+
"devtools": "${getPackageWithVersion('overmind-devtools')}"
11+
}
12+
}
13+
`,
14+
},
15+
]

packages/overmind-website/guides/beginner/01_getstarted.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,18 @@ At this stage, the benefits of writing an application code this way might not be
7070
h(Example, { name: "guide/getstarted/devtools" })
7171
```
7272

73+
You can also explicitly install the devtools with
74+
75+
`npm install overmind-devtools`
76+
77+
and rather:
78+
79+
```marksy
80+
h(Example, { name: "guide/getstarted/devtools_explicit" })
81+
```
82+
83+
This allows you to control the version you want to use.
84+
7385
The Overmind devtools provides us with a pretty amazing experience. We get insights into all the state, changes to that state, actions run, which side effects are run and general stats. This visual overview becomes more and more valuable as complexity increases.
7486

7587
To connect to the devtools simply start the devtools application and refresh your app.

0 commit comments

Comments
 (0)