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

ci: Generate contract docs #130

Closed
wants to merge 4 commits into from
Closed

ci: Generate contract docs #130

wants to merge 4 commits into from

Conversation

fadeev
Copy link
Member

@fadeev fadeev commented Mar 11, 2024

  • modified doc comments in contracts/evm/tools/ImmutableCreate2Factory.sol to fix build issues
  • imported solidity-docgen to add npx hardhat docgen command
  • added templates dir with templates for docgen

yarn docs generates markdown files from contracts. Once merged, I'll add a workflow to the docs repo to check for changes and automatically create PRs.

@fadeev fadeev changed the title Generate contract docs ci: Generate contract docs Mar 11, 2024
Copy link

socket-security bot commented Mar 11, 2024

@fadeev
Copy link
Member Author

fadeev commented Mar 11, 2024

"Generated files" workflow fails, because this is not merged yet #129

@fadeev
Copy link
Member Author

fadeev commented Apr 5, 2024

@brewmaster012 @lumtis @CharlieMc0 please, review, need a second approval. Thanks!

@fadeev
Copy link
Member Author

fadeev commented May 27, 2024

Replaced with #154

@fadeev fadeev closed this May 27, 2024
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