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.

Sign up for GitHub

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

Jump to bottom

adding documentation for each package #66

Open

6 of 7 tasks

dhruvmalik007 opened this issue Sep 26, 2022 · 0 comments

Assignees

Contributor

dhruvmalik007 commented Sep 26, 2022 •

edited

Loading

define the README for each of package in v1 version that will be defining the following sections:

About Description(short description of the functionality of the contracts in the protocol).
interface for each of the contract with the description
dependencies on the other contracts and parties.
security points
Workflow
installation/setup.

tasks

documentations gitbook:

description of the gitbook protocol and FAQ

next steps:

Once all the above packages are completed, @drikssy will be reviewing and merging the details.

dhruvmalik007 self-assigned this

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