forked from hms-dbmi/vizarr
-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
What needs updating?
The package needs documentation for installation, basic usage e.g. for displaying on npm website https://www.npmjs.com/package/@hms-dbmi/vizarr.
Suggest using something like JSDoc (https://jsdoc.app/about-getting-started) to generate more detailed documentation for components etc. which can be hosted e.g. via gh-pages.
Where should this be updated?
https://docs.npmjs.com/about-package-readme-files A README.md can be added at the package root.
Additional context
Add any other relevant context about the documentation request.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation