cosmicds / vue-toolkit

Vue-based toolkit for creating Cosmic Data Stories using WorldWide Telescope
https://www.npmjs.com/package/@cosmicds/vue-toolkit
MIT License
0 stars 4 forks source link

Add documentation to composables and utility functions #9

Closed Carifio24 closed 6 months ago

Carifio24 commented 6 months ago

This PR sets up documentation for our utility functions, composables, classes, and interfaces using TypeDoc. TypeDoc uses JSDoc-style comments to generate docs.

However, this does not include our components, which is a pretty big blind spot for what is primarily a component library. That's intentional, for now - I plan on setting up Storybook documentation for our components and integrating these TypeDoc docs into that. But I'll start with the non-component docs now, and set up Storybook in another PR soon.