Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compile documentation with jsdoc #87

Open
pverscha opened this issue Dec 11, 2019 · 1 comment
Open

Compile documentation with jsdoc #87

pverscha opened this issue Dec 11, 2019 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@pverscha
Copy link
Member

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 pverscha added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 11, 2019
@pverscha pverscha added this to the Release 0.2 milestone Dec 11, 2019
@pverscha pverscha self-assigned this Dec 11, 2019
@pverscha
Copy link
Member Author

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.

@pverscha pverscha modified the milestones: Release 0.2, Release 0.3 Apr 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant