search

testdeck / testdeck-site

the testdeck site source
https://testdeck.org
0 stars 0 forks source link

Reference/Public API section #23

Closed silkentrance closed 5 years ago

silkentrance commented 5 years ago

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 commented 5 years ago

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.