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

Update Solidity API docs PR comments, do not create a new one each push #52

Open
michalinacienciala opened this issue Mar 7, 2024 · 0 comments
Assignees
Labels
📖 documentation Improvements or additions to documentation

Comments

@michalinacienciala
Copy link
Collaborator

Previously we've been adding comments to PRs modifying Solidity contracts about available previews of the API documentation. As each push to the PR branch results in one such comment, PRs with a lot of pushes get quite busy with a lot of the similar comments. In the future it would be good to modify our commenting mechanism so that it would just leave one comment per PR and update it on each push. Until we do that we're turned off the PR commenting, to increase readability.

Ref:
keep-network/tbtc-v2#793
keep-network/keep-core#3791
threshold-network/solidity-contracts#165

@michalinacienciala michalinacienciala added the 📖 documentation Improvements or additions to documentation label Mar 7, 2024
@michalinacienciala michalinacienciala self-assigned this Mar 7, 2024
@michalinacienciala michalinacienciala changed the title Update Solidity API docs PR comments, not created new one each push Update Solidity API docs PR comments, do not create a new one each push Mar 8, 2024
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
None yet
Development

No branches or pull requests

1 participant