-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Documentation #107
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The text was updated successfully, but these errors were encountered: