effectai/effect-js

Update Documentation

Jeffrieh opened this issue · 0 comments

I have started the beginnings of a documentation framework using Vocs.
Vocs is a minimal static documentation generator where we write our content in Markdown or MDX, and Vocs will generate a static site with a default theme.

The current structure is very minimal and can be found in the /docs folder.
I would love/welcome any contributions made torwards completing the documentation for V2. In particular the API/actions that are in the new SDK can be documented, Every API has to have a usage, returns and paramters section. For an example/template of how to structure this see: https://github.com/effectai/effect-js/blob/dev/docs/pages/docs/tasks/campaigns/getCampaigns.mdx