AllenCell / AllenCell/vole-core
add typedoc to package.json
Open
milestone candidate
- Dominant language
- TypeScript
- Stars
- 106
- Forks
- 11
- Avg merge
- 3d 51m
- Merged PRs (30d)
- 12
Description
## Use Case
to do refactoring it is useful to have a visualization of apis, classes and maybe call graphs
## Solution
typedoc can provide most of this. We can add it as devdependency and add a package.json script to generate the visualization for developer use. Doesn't need to be part of ci/cd.
## Alternatives
other doc generation tools? typedoc seems pretty good.
Contributor guide
Assessment
This issue has not been assessed yet.