Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc generation usage experience improvements #140

Merged
merged 6 commits into from
Apr 12, 2024
Merged

Conversation

galekseev
Copy link
Member

Changes overview

  1. Added method to quickly get 1inch templates for usage in projects that use oz solidity-docgen
  2. Moved doc templates to separate folder (to have all OZ docgen stuff in one place)
  3. Changed default folder for copying read.me to OZ docgen default

@galekseev galekseev requested review from zZoMROT and ZumZoom April 8, 2024 17:53
Copy link

codecov bot commented Apr 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.23%. Comparing base (ebf0bce) to head (57a5f36).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #140   +/-   ##
=======================================
  Coverage   93.23%   93.23%           
=======================================
  Files          17       17           
  Lines         340      340           
  Branches       66       66           
=======================================
  Hits          317      317           
  Misses         23       23           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Updated version to 4.2 since doc generation has breaking changes.
package.json Outdated Show resolved Hide resolved
@zZoMROT
Copy link
Contributor

zZoMROT commented Apr 8, 2024

Could you please patch readme related to docgen? I'm not sure about solc version for new docgen - should it be upgraded or not 🤷‍♂️

@galekseev
Copy link
Member Author

Could you please patch readme related to docgen? I'm not sure about solc version for new docgen - should it be upgraded or not 🤷‍♂️

fixed

@galekseev galekseev requested a review from zZoMROT April 10, 2024 22:20
@galekseev galekseev merged commit 7e895ad into master Apr 12, 2024
8 checks passed
@galekseev galekseev deleted the docs/new-oz-docgen-1 branch April 12, 2024 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants