Add an "Architecture" Section to the README #551
Closed
scorpion9979
started this conversation in
Ideas
Replies: 1 comment
-
|
Implemented in #661. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
As the protocol moves closer to public release, it may be beneficial to include an "Architecture" section in the README. The intent behind this is to provide a bird's-eye view of the codebase to aid researchers, developers, and other community members in better understanding the structure and functioning of the protocol.
A good inspiration for this could potentially be the architecture section provided in the Uniswap V4 README.
Beta Was this translation helpful? Give feedback.
All reactions