eclipse-theia / generator-theia-extension

A Yeoman generator for extensions to the Theia IDE
Other
56 stars 40 forks source link

Instructions how to start examples are inconsistent #90

Closed JonasHelming closed 3 years ago

JonasHelming commented 3 years ago

As mentioned in the discussion below, the instructions in the Readme on how to launch the examples are inconsistent. In the "how to run" sections it mentions the CLI command, in the "how to develop" it mentions the VSCode configs. I suggest to:

I'm a little confused as to why the docs describe the watch workflow in such a way where we need to launch the backends with vscode, we can alternatively also describe how to do so simply with the terminal.

I agree that it would make sense to at least also mention that the backend can be started from within VSCode via the launch config or with e.g. cd browser-app; yarn start. Do you want me to open a separate PR with a proposal?

If you'd like to and agree it adds value for extension developers then please feel free to open the PR :)

Originally posted by @vince-fugnitto in https://github.com/eclipse-theia/generator-theia-extension/issues/82#issuecomment-771848462