bigtest
bigtest copied to clipboard
thefrontside
Automatically generate and release API docs
We'll want to add some kind of workflow to generate and release documentation, probably via Netlify. It would be great to have both an edge documentation which documents the current working branch, as well as versioned documentation for the various release versions.
Additionally we're able to generate docs for either bigtest as a whole, or just the interactors, should we generate two separate sets of documentations?
The guides we're working on will not be versioned, probably for some more time. It increments the complexity greatly and is probably not worth it at the moment.
Though, Versioning the API sounds reasonable. It doesn't seem that Typedoc offers that option. We probably have to build some kind of mechanism, I guess on top of Docusaurus. I'd postpone versioning the API and limiting ourselves to indicating the version that is currently displayed.
I'm totally cool with not versioning at all for the time being. I was just throwing that out there as an idea.
I believe with the addition of https://github.com/thefrontside/bigtest/pull/715 that we could version the docs including the typedoc API whenever we are ready.
