docs: Add README documentation for contract directories #172
Conversation
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
- Add contracts/README.md with overview of directory structure - Add contracts/beanstalk/README.md documenting Diamond architecture - Add contracts/beanstalk/facets/README.md with complete facet reference - Add contracts/ecosystem/README.md for peripheral contracts - Add contracts/libraries/README.md categorizing all libraries - Add contracts/tokens/README.md documenting Bean token - Add contracts/pipeline/README.md explaining Pipeline utility
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 comprehensive README documentation to the contracts directory and its subdirectories to improve code navigation and developer onboarding.
Changes Added
New Files (7 READMEs)
contracts/README.md
contracts/beanstalk/README.md
contracts/beanstalk/facets/README.md
contracts/ecosystem/README.md
contracts/libraries/README.md
contracts/tokens/README.md
contracts/pipeline/README.md
Why This Change
Comprehensive documentation helps developers understand the codebase structure, navigate the Diamond architecture, and quickly find relevant contracts and libraries.