Split contracts API doc into multiple files #3657
Conversation
michalinacienciala
force-pushed
the
split-api-docs-to-multiple-files
branch
from
d63319a
to
c93e46d
Compare
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402099144 check. |
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402099142 check. |
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402113668 check. |
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402113664 check. |
michalinacienciala
force-pushed
the
split-api-docs-to-multiple-files
branch
from
c93e46d
to
424e440
Compare
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402502186 check. |
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402502193 check. |
michalinacienciala
force-pushed
the
split-api-docs-to-multiple-files
branch
from
424e440
to
9bf45c7
Compare
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402582338 check. |
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5402582335 check. |
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 delitions in the PR diff).
michalinacienciala
force-pushed
the
split-api-docs-to-multiple-files
branch
from
9bf45c7
to
13ad2b2
Compare
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5403544537 check. |
|
Docs updated in threshold-network/threshold#36. |
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/keep-core/actions/runs/5403544533 check. |
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 PAGEsection, we don't need to generate Table of Contents. The one thing that we also change as part of this PR isrsyncDeletesetting - we'll have it set totrue, in order to delete documentation of contracts which get removed from the repo. As we're not working directly on amainbranch, this isn't dangerous (we'll see all the deletions in the PR diff).Refs:
threshold-network/solidity-contracts#149
keep-network/tbtc-v2#640
threshold-network/threshold#36