Skip to content
This repository has been archived by the owner on Jul 17, 2023. It is now read-only.

Publish API documentation as a web page #73

Open
robertrossmann opened this issue Feb 20, 2019 · 0 comments
Open

Publish API documentation as a web page #73

robertrossmann opened this issue Feb 20, 2019 · 0 comments

Comments

@robertrossmann
Copy link
Member

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
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant