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

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

michalinacienciala
Copy link
Contributor

@michalinacienciala michalinacienciala commented Jul 5, 2023

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:

@michalinacienciala michalinacienciala self-assigned this Jul 5, 2023
@github-actions
Copy link

github-actions bot commented Jul 5, 2023

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

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

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

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

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

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

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

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

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

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

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

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`.
@michalinacienciala michalinacienciala changed the title Test postProcessingCommand adding a warning block Inform in API docs about contracts not being deployed to Mainnet Jul 6, 2023
@michalinacienciala michalinacienciala added the 📖 documentation People need to know things! label Jul 6, 2023
@github-actions
Copy link

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

@github-actions
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation People need to know things!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant