docs: Add README documentation for missing contract directories#2745
Open
AdekunleBamz wants to merge 1 commit intoOriginProtocol:masterfrom
Open
docs: Add README documentation for missing contract directories#2745AdekunleBamz wants to merge 1 commit intoOriginProtocol:masterfrom
AdekunleBamz wants to merge 1 commit intoOriginProtocol:masterfrom
Conversation
- Add automation/README.md documenting Safe modules for protocol operations - Add beacon/README.md explaining Beacon Chain proof verification - Add bridges/README.md documenting LayerZero OFT adapters - Add buyback/README.md explaining yield buyback mechanisms - Add poolBooster/README.md documenting liquidity incentive contracts - Add zapper/README.md explaining cross-chain zapper utilities
AdekunleBamz
requested review from
clement-ux,
naddison36,
shahthepro and
sparrowDom
as code owners
Collaborator
|
README files that list the contracts in the folder add little value and become and overhead to maintain if there is not an automated way to generate the lists. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR adds README documentation to contract directories that were missing them, complementing the existing documentation coverage in the repository.
Changes Added
New Files (6 READMEs)
contracts/contracts/automation/README.md
contracts/contracts/beacon/README.md
contracts/contracts/bridges/README.md
contracts/contracts/buyback/README.md
contracts/contracts/poolBooster/README.md
contracts/contracts/zapper/README.md
Why This Change
Several contract directories lacked README documentation. This PR fills those gaps to help developers understand each module's purpose and architecture.