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

feat: generate contract docs with forge doc #154

Merged
merged 3 commits into from
May 28, 2024
Merged

feat: generate contract docs with forge doc #154

merged 3 commits into from
May 28, 2024

Conversation

fadeev
Copy link
Member

@fadeev fadeev commented May 27, 2024

Just uses forge doc to generate the docs. Looks good, works fast, much better than alternatives.

The idea is that we add this automatically to the docs website.

Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Don't we have this functionality with Hardhat already?

@fadeev
Copy link
Member Author

fadeev commented May 27, 2024

@lumtis I think Forge generates nicer output.

@fadeev fadeev merged commit d21bce5 into main May 28, 2024
11 checks passed
@fadeev fadeev deleted the forge-doc-gen branch May 28, 2024 18:13
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.

3 participants