Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(overmind-devtools): document overmind-devtools for easier local development #617

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions packages/overmind-devtools-client/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# overmind-devtools
### Introduction

To be filled
There are three packages related to `overmind-devtools` experience:
* [overmind-devtools-client](../overmind-devtools-client/) - "core" package that provides UI ("web client")
* [overmind-devtools](../overmind-devtools/README.md) - standalone, electron application
* [overmind-devtools-vscode](../overmind-devtools-vscode/) - VSCode extension

`overmind-devtools-client` is a core application that can be hosted by available "hosts": `overmind-devtools` and `overmind-devtools-vscode`.

![overmind-devtools-packages](./docs/assets/overmind-devtools-packages.png)

This means that this package (a reminder: we're now in `overmind-devtools-client` package of the monorepo) is **crucial** for the other two.

In case you want to improve devtools experience (UI, UX, etc.), focus on this package specifically.

### Local development
This package bundle (`bundle.js`) is further used by the companion "host" packages (mentioned before).

Hence, make sure you've build this package before development.

**HINT**: the easiest way to start local development is to run [overmind-devtools](../overmind-devtools/README.md) electron app.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading