Inform in API docs about contracts not being deployed to Mainnet - Githubissues

keep-network / keep-core

The smart contracts and reference client behind the Keep network

https://keep.network

MIT License

118 stars 73 forks source link

Inform in API docs about contracts not being deployed to Mainnet #3671

Open michalinacienciala opened 1 year ago

michalinacienciala commented 1 year ago

We want to add a note to each generated API doc for Random Beacon that informs about contracts not being deployed on Mainnet. The note is in style used by GitBook to highlight important information (read more: https://docs.gitbook.com/content-creation/blocks/hint#git-sync-representation-in-markdown). The note is inserted between 5th and 6th line of each generated doc.

Note: This commit contains a temporary change of the triggering conditions for the publish job. We need to remove this change before merging to main.

Before merging this PR we must:

[x] merge the https://github.com/keep-network/ci/pull/47 first
[x] re-run the https://github.com/keep-network/keep-core/actions/runs/5472175032 check
[ ] verify if the PR with the updated docs will be created in the threshold repo and merge it
[ ] verify if the documentation in API section for Random-Beacon in docs.threshold.network displays as we wish
[ ] remove the testing configuration from the current PR (marked by TODO in code)

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5464988862 check.

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5465046624 check.

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5465117329 check.

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5465273149 check.

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5465553264 check.

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5465741265 check.

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5472175032 check.

github-actions[bot] commented 1 year ago

Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5597308274 check.