Generate Solidity documentation - #111
Merged
Merged
Conversation
james-toussaint
commented
Aug 22, 2024
james-toussaint
commented
Contributor
- Preview: https://github.com/iExecBlockchainComputing/PoCo/blob/feature/generate-sol-doc/docs/solidity/index.md
- Notes:
- Particularly nice when code is properly documented (makes sense 🙃)
- Decided to use the "single-page" format since Poco contracts are mostly forming a "diamond" proxy, hence it is easier for users to get info in a single page rather than looking/browsing many files
- Sample:
james-toussaint
marked this pull request as ready for review
August 22, 2024 15:15
zguesmi
approved these changes
Aug 22, 2024
| docgen: { | ||
| outputDir: 'docs/solidity', | ||
| templates: 'docs/solidity/templates', | ||
| exclude: [ |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #111 +/- ##
========================================
Coverage 83.75% 83.75%
========================================
Files 34 34
Lines 1077 1077
Branches 222 202 -20
========================================
Hits 902 902
Misses 175 175 ☔ View full report in Codecov by Sentry. |
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.