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

Generate documentation for smart contracts #553

Closed
pdyraga opened this issue Feb 21, 2023 · 0 comments · Fixed by keep-network/ci#43, keep-network/keep-core#3534, #584 or threshold-network/solidity-contracts#138
Assignees

Comments

@pdyraga
Copy link
Member

pdyraga commented Feb 21, 2023

We want the documentation to be generated as a part of the CI flow and automatically uploaded to https://docs.threshold.network/contracts. All the contracts and functions are quite heavily documented. We need to use some tooling (e.g. OpenZeppelin has one) to generate HTMLs similar to https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#IERC20.

This task has several smaller items, I recommend we start with choosing a tool and then integrating it with a CI. The infrastructure work with the upload should be the last step.

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