[Docs] Diagram representation of the chembl_webresource_client #139
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.
This PR adds an architectural diagram of the chembl_webresource_client codebase to help new contributors quickly understand its structure.
You can see how the change renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/chembl_webresource_client/on_boarding.md
I would love to hear what do you think of auto generate diagram first documentation. This way it can always be up-to-date, (generated with Static Analysis and LLMs) if you like what you see I'd be more than happy to also make a PR with our free to use github action :)
Since Discussions aren’t enabled, I’m sharing this via PR.
Disclamer: We're doing this as part of an early-stage startup, exploring what’s most helpful for OSS maintainers.