Skip to content

Added high-level diagrams #3723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Conversation

ivanmilevtues
Copy link

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

  • Clean up commit history
  • Add or update documentation related to these changes
  • Add entry to the release notes

Cute Animal Picture

I love the American Fuzzy Lop :)

Put a link to a cute animal picture inside the parenthesis-->

@kclowes
Copy link
Collaborator

kclowes commented Jun 23, 2025

The diagram/docs you added aren't really the API we want to encourage users to use, and this information is handled already in our docs.

@kclowes kclowes closed this Jun 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants