eclipse-theia / theia-website

Theia's Website
https://theia-ide.org/
Other
33 stars 73 forks source link

[content] improve documentation guiding from 'manual json' to yeoman #611

Open srl295 opened 1 day ago

srl295 commented 1 day ago

Note: Reference https://github.com/eclipse-theia/theia/discussions/14244

  1. Reading https://theia-ide.org/docs/composing_applications/ the implication is that the 'manual' JSON approach is equivalent to the generator, with the difference that you have to manually type in the files. But it seems that in reality the approaches are a little different: In my words, the 'manual' approach basically runs theia via the CLI, where the generator builds a scaffolded application which you can then modify.

Consider something at the end of that page that describes and contrasts the generator approach as a next step.

  1. When jumping into the generator at https://theia-ide.org/docs/composing_applications/ and even the guide https://theia-ide.org/docs/authoring_extensions/ which seems to be a tutorial on using the generator, there's a little bit of transition needed.

Now, i've been around especially Eclipse, but also VSCode, so I get the world where "everything is an extension", as disussed in https://theia-ide.org/docs/architecture/

However, I think what's missing is something that says, "In order to build your own IDE/Tool, what you need to do is

  1. start with generating an extension that adds the top level functionality you want https://theia-ide.org/docs/authoring_extensions/#project-layout
  2. besides the extension, the two generated Theia applications may then be customized for your specific needs..

Assuming all of that is true. Anwyay, this is part of my evaluation, so I'm surmising how this is all supposed to work.


Just one more note on terminology:

This guide will walk you through the process of creating Theia extensions and deploying them in your Theia-based application

JonasHelming commented 1 day ago

Also we should clarify better when to use the generator and when the Theia IDE, see https://github.com/eclipse-theia/theia/discussions/14244#discussioncomment-10848997