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.

Sign up for GitHub

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

Jump to bottom

docs: replace hardhat/solidity-docgen with forge doc #431

Closed
alvrs opened this issue Feb 22, 2023 · 1 comment
Closed

docs: replace hardhat/solidity-docgen with forge doc #431

alvrs opened this issue Feb 22, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@alvrs
Copy link
Member

alvrs commented Feb 22, 2023

Since we mostly use forge over hardhat in this repo and since forge has a feature to parse docs from natspec (foundry-rs/foundry#1675), we should revisit our solidity doc generation pipeline and potentially replace solidity-docgen (which requires a hardhat setup) with forge doc
@alvrs alvrs added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 22, 2023
@alvrs alvrs mentioned this issue Feb 22, 2023
Merged
@holic
Copy link
Member

holic commented Jan 24, 2024

done in #1762

@holic holic closed this as completed Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@holic @alvrs