atlas.js icon indicating copy to clipboard operation
atlas.js copied to clipboard

Publish API documentation as a web page

Open robertrossmann opened this issue 6 years ago • 0 comments

Having publicly accessible API documentation could help developers discover features of Atlas and generally help navigating the landscape. Now that we have TS typings we could use TypeDoc. Preliminary research suggests this will work quite well at least for the main Atlas package:

npx typedoc --mode modules --out docs --exclude "**/node_modules/**" --includeDeclarations --excludeExternals packages/atlas

robertrossmann avatar Feb 20 '19 09:02 robertrossmann