Publish docs

[josephjclark]

We need to generate and post docs somewhere.

I think this is a githib actions thing - we should add an action to build docs and publish them to github.io.

We can probably then exclude docs from the standard build command.

[taylordowns2000]

I'm in love with the algolia search we get from docs.OpenFn.org - would it be possible to use docusaurus to generate docs from js docs?

And how should docs.OpenFn.org integrate with the adaptor documentation?

https://gist.github.com/slorber/0bf8c8c8001505f0f99a062ac55bf442

https://realworldjs.medium.com/automatic-documentation-for-javascript-projects-readme-jsdoc-mermaid-86b86be9b28d

[taylordowns2000]

@josephjclark , more thoughts on docs from Aleksa:

currently documentation for adaptors lives in two places:

1. https://docs.openfn.org/documentation/apps/dhis2
2. https://openfn.github.io/language-dhis2/

if we're generating docs here using something like docusaurus, could/should we subsume those "apps" pages on docs.openfn.org into the adaptors documentation here? i'm imagining a structure like this getting published:

README.md # comes from existing /adapors/dhis2/readme.md -> turns into landing page
PLATFORM-USAGE.md # comes from existing docs.openfn.org/documentation/apps/dhis2 -> turns into page that sits next to landing page
docs/ # all the JsDoc/TsDoc stuff is built here

Alternatively, we could combine README.md and PLATFORM-USAGE.md, but I think separate is better as the first is aimed at adaptor developers and the second is aimed at platform users. Thoughts?

cc @stuartc , @mtuchi

🎯 STRETCH GOAL 🎯 - How do we create a docs build for each version that's published to npm?

[taylordowns2000]

@mtuchi , this issue should now be focused ONLY on the yellow box... a github action which builds and commits the docs to the docs branch