Update Solidity API docs #36
Merged
Conversation
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
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. The docs got published in previous commits, in this commit we update the GitBook;s navigation.
This was referenced Jun 28, 2023
pdyraga
approved these changes
Jun 29, 2023
Comment on lines
+3
to
+4
| You can learn about APIs of contracts related to the Random Beacon under the | ||
| following links: |
There was a problem hiding this comment.
This copy could be a bit better. We could point the reader to the repository, say that the code documentation was generated automatically based on the docs in the code.
| You can learn about APIs of contracts related to the Random Beacon under the | ||
| following links: | ||
|
|
||
| [AltBn128](./generated-docs/libraries/AltBn128.md) |
There was a problem hiding this comment.
Wouldn't it be better to have them as a bullet list?
There was a problem hiding this comment.
Same question to all README.md files in this PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Docs updated by workflow: https://github.com/threshold-network/solidity-contracts/actions/runs/5399972528