Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference/Public API section #23

Closed
silkentrance opened this issue Apr 4, 2019 · 1 comment
Closed

Reference/Public API section #23

silkentrance opened this issue Apr 4, 2019 · 1 comment
Labels

Comments

@silkentrance
Copy link
Member

silkentrance commented Apr 4, 2019

Epic: #4

we need a public api reference section

this does not include information on the API used for authoring new integrations

I have looked into the available API doc generators and typedoc seems to be the best one. However, the generated API docs can only be linked to and cannot be embedded into the official documentation unless we go to lengths and provide custom templates, which is something that I would not want to do.

So, for the time being, everything will be laid out by hand...

@silkentrance
Copy link
Member Author

I have looked into this and found that it actually makes no sense at all to provide such a reference section. We should instead focus on documentation of the sources instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant