search

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

Split contracts API doc into multiple files #3657

Closed michalinacienciala closed 1 year ago

michalinacienciala commented 1 year ago

Having all the contracts documented in one common file turned out to be hard to render by the GitBook. We're switching to documenting each contract file in a separate Markdown file. As the generated files will be much smaller now and GitBook has its own file ON THIS PAGE section, we don't need to generate Table of Contents. The one thing that we also change as part of this PR is rsyncDelete setting - we'll have it set to true, in order to delete documentation of contracts which get removed from the repo. As we're not working directly on a main branch, this isn't dangerous (we'll see all the deletions in the PR diff).

Refs: https://github.com/threshold-network/solidity-contracts/pull/149 https://github.com/keep-network/tbtc-v2/pull/640 https://github.com/threshold-network/threshold/pull/36

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/5402099144 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/5402099142 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/5402113668 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/5402113664 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/5402502186 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/5402502193 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/5402582338 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/5402582335 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/5403544537 check.

michalinacienciala commented 1 year ago

Docs updated in https://github.com/threshold-network/threshold/pull/36.

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/5403544533 check.