Skip to content
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

docs(contracts): add draft docs for contracts #328

Merged
merged 1 commit into from
Sep 12, 2024
Merged

Conversation

0xmad
Copy link
Collaborator

@0xmad 0xmad commented Sep 11, 2024

  • Add script for uml generation
  • Add docs for contracts with interaction and integration details

Related to #263

@0xmad 0xmad added the documentation Improvements or additions to documentation label Sep 11, 2024
@0xmad 0xmad self-assigned this Sep 11, 2024
Copy link

vercel bot commented Sep 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
maci-platform ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 11, 2024 9:10pm

- [x] Add script for uml generation
- [x] Add docs for contracts with interaction and integration details
Copy link
Collaborator

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@ctrlc03 ctrlc03 merged commit 922ef7d into main Sep 12, 2024
16 checks passed
@ctrlc03 ctrlc03 deleted the docs/contracts branch September 12, 2024 06:35
Copy link
Contributor

@kittybest kittybest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just some questions on the description of parameters, could also open an issue for them


#### Properties

- **easId**: `uint256` - Unique identifier for the EAS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this a certain EAS schema id? maybe it's better that we provide example of how should it be like here?


#### Properties

- **contractId**: `uint256` - Unique identifier for the contract.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be the address of the EAS Registry contract, right? then I think we could specify it instead of just say it's a unique identifier for the contract?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants