Added high-level diagrams #3723
Closed
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.
What was wrong?
This PR introduces diagram representation of the web3.py codebase. You can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/web3.py/on_boarding.md
The goal of the diagram is to give an overview of the codebase, where it shows the main components and how they interact with eachother. We believe visualization is the best way to get to know new codebase, as it gives you context. When a new contributor starts their first task they can use the docs to narrow down the component in which they have to work and then find the relevant source files (which are linked), then when starting the task they'd have context on how what they are doing fits in the bigger picture of the codebase. Let me know what do you think of diagram first documentation generation!
Any feedback is more than welcome!
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people. Further we have introduced free github action, to keep these docs up-to-date so that we don't introduce another maintainance task for the team :)
How was it fixed?
Not relevant
Todo:
Not super relevant
Cute Animal Picture
I love the American Fuzzy Lop :)