You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.
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; ..).
The text was updated successfully, but these errors were encountered:
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; ..).
The text was updated successfully, but these errors were encountered: