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
The API that a Vue-component offers is not always directly clear. To improve maintainability of this project, we should indicate all events that are emitted by a component (as well as the props it takes in) using the JS Doc-extension jsdoc-vuejs (https://www.npmjs.com/package/jsdoc-vuejs).
To further improve this, we could even set up a GitHub-action that automatically compiles the documentation when a push occurs.
The text was updated successfully, but these errors were encountered:
I chose for the "vue-styleguidist"-package for compiling documentation for the different components as it looks the most promising. No GitHub-action that automatically compiles the documentation (and publishes it) is currently created.
The API that a Vue-component offers is not always directly clear. To improve maintainability of this project, we should indicate all events that are emitted by a component (as well as the props it takes in) using the JS Doc-extension
jsdoc-vuejs
(https://www.npmjs.com/package/jsdoc-vuejs).To further improve this, we could even set up a GitHub-action that automatically compiles the documentation when a push occurs.
The text was updated successfully, but these errors were encountered: