Create documentation

[lfolco]

Is your feature request related to a problem? Please describe.
Is there any documentation on how to use some of the more involved code generation features? For example, the UI Component listing; the fields have no explanation as to what is required, and you can end up with a bunch of files that make no sense

Describe the solution you'd like (*)

Documentation or a wiki on how to use these features.

Describe alternatives you've considered

Googling how to use it, or just entering what I think it's looking for and getting it wrong.

Additional context

This is very unclear as to what it's looking for:

Mainline branch: 4.3.0-develop

[m2-assistant]

Hi @lfolco. Thank you for your report.
To help us process this issue please make sure that you provided sufficient information.

Please, add a comment to assign the issue: @magento I am working on this

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[DmitryFurs]

@lfolco You can find a description of most of the features here https://github.com/magento/magento2-phpstorm-plugin/wiki

[lfolco]

That's great, but it would be a lot easier to find what you're looking if it were in a wiki page about actual documentation. I'm more than happy to do so if I'm given permission here.

[bohdan-harniuk]

Hello, @lfolco!

I see here two options:

1. add hints for inputs with detailed information what does current input mean
2. we have an official documentation, but we have not any contributor that want to work with it...if you want, you can write some articles in the official documentation

Best regards,

[lfolco]

Hints would be ideal, since it would work within the plugin.

[Iamwade]

@magento I am working on this

[Iamwade]

Hi @bohdan-harniuk Thank you very much for helping me complete the issue.
At the moment, we have implemented the functionality to add placeholders to all dialog windows that are used in the plugin.
You can now add a placeholder in the window editor.
"Client Properties" -> "promptText"


We didn't have this opportunity before!
Now we can add tooltips to all forms where needed.

I suggest creating issue for each dialog window separately. In the tasks, we can also discuss what tips will be most useful to the developer!

[bohdan-harniuk]

Hello, @Iamwade!

Thank you for your work here!
Let's keep this issue opened, as you suggested.

Regards,