cli icon indicating copy to clipboard operation
cli copied to clipboard

[Feedback] add additional comments at the top of generated files

Open julpat opened this issue 1 year ago • 1 comments

Feedback

When users are discovering generated files, they miss the context, purpose, and relations of these files right away. They are forced to google/go to documentation and lose the flow.

Possible solution

To help with that add brief comments at the top of each generated file. It will describe the purpose and relations with other files (where is it in the Superface), link to the glossary, and indicate usage (profile to change inputs/outputs; map to debug integration; ..).

julpat avatar Aug 15 '23 13:08 julpat

This might be complicated for provider definition (JSON) but otherwise should be ok (Engine adding Comlink/JS comment on top of each generated file)

Jakub-Vacek avatar Aug 28 '23 07:08 Jakub-Vacek