Generate markdown files for Solidity API documentation #133
Conversation
This file contains 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
Use Open Zeppelin's [solidity-docgen tool](https://github.com/OpenZeppelin/solidity-docgen) to generate markdown files for solidity contracts documentation. To run the generation: `pnpm run docs` The files will be output in `gen/docs/` directory.
|
This is good. We should've added this at the beginning 😅 Can we go through the contracts and fix how the docs are being displayed? E.g. Acre.depositParameters docs display incorrectly. |
Can we fix the contract documentation in another PR? I guess there will be quite a few things to fix :) |
dimpar
approved these changes
Jan 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Use Open Zeppelin's solidity-docgen tool to generate markdown files for solidity contracts documentation.
To run the generation:
pnpm run docsThe files will be output in
gen/docs/directory.