search

unipept / unipept-web-components

This repository contains isolated Vue-components that can be reused throughout multiple Unipept-projects.
1 stars 1 forks source link

Compile documentation with jsdoc #87

Open pverscha opened 4 years ago

pverscha commented 4 years ago

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.

pverscha commented 4 years ago

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.