Split contracts API doc into multiple files#149
Merged
Conversation
michalinacienciala
force-pushed
the
split-api-docs-to-multiple-files
branch
from
7771d7a to
f5c2835
Compare
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).
We were not consistent in the using of extension for the YAML files. We're switching `.yaml` to `.yml` to use the same convention everywhere.
michalinacienciala
force-pushed
the
split-api-docs-to-multiple-files
branch
from
f5c2835 to
24f5c2f
Compare
|
Solidity API documentation preview available in the artifacts of the https://github.com/threshold-network/solidity-contracts/actions/runs/5401860443 check. |
Contributor
Author
|
Docs updated in threshold-network/threshold#36. |
michalinacienciala
added
the
documentation
This was referenced Jun 28, 2023
pdyraga
approved these changes
Jun 29, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).As part of this PR we also unify the naming convention for the YAML files - we want to use
.ymleverywhere. With.yamlused in contracts-docs workflow, the filter job was misconfigured.Refs:
threshold-network/keep-core#3657
threshold-network/tbtc-v2#640
threshold-network/threshold#36