Open baltpeter opened 1 year ago
That of course means we'll also need to deploy the docs somewhere. Since Typedoc generates a static site, that isn't too hard. But I'm not quite sure where to put them, considering we (will) have many modules.
If we have an individual dattel site per module (which would make the CI setup easier), we would need a subdomain per module, maybe <module name>.docs.tweasel.org
. But I don't really like that.
I would prefer docs.tweasel.org/<module name>
but for that we would need a single dattel site (since dattel doesn't support deploying to a folder). And that means, we'd need a separate CI pipeline that gets triggered whenever we change something in one of the modules.
But actually, maybe the effort for the separate CI pipeline is worth it. We should really not only publish the documentation for the current version, anyway. We need to also publish the older versions and allow easy access to that (maybe docs.tweasel.org/<module name>/<version>
).
Also, we should update TypeDoc in our packages. I have also run into this problem, and it should be fixed in newer versions: https://github.com/TypeStrong/typedoc/issues/2156
This looks highly relevant: https://www.npmjs.com/package/typedoc-plugin-versions
We could also consider: https://github.com/milesj/docusaurus-plugin-typedoc-api/blob/master/packages/plugin/README.md
We're currently using
typedoc-plugin-markdown
for our API reference documentation.But I've noticed that the output from that is quite lacking with the complex TypeScript we're using. From a little bit of experimentation, Typedoc proper seems to produce better (and easier to read) results. So, we should switch to that.