Add Deployments preprocessor to forge doc
#5092
Merged
Conversation
This file contains 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
clabby
force-pushed
the
feat/deployment-docs
branch
from
445ee5f
to
80f7da9
Compare
Remove reference project :broom:
clabby
force-pushed
the
feat/deployment-docs
branch
from
80f7da9
to
f552970
Compare
mattsse
reviewed
May 31, 2023
mattsse
reviewed
May 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Adds a new preprocessor / flag to
forge docthat allows for generating deployment documentation fromhardhat-deployorforge-deployartifacts.Usage
If there is a
deploymentsartifact directory present fromforge-deployorhardhat-deploy, pass the--deployments / -dflag toforge docto add a deployment table to all contracts with deployment artifacts.