Skip to content

Update Documentation #107

Description

@Jeffrieh

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions