Visualization for the python-nomad codebase #174
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
|
We are now open-source as well: https://github.com/CodeBoarding/CodeBoarding. If interested you can check exactly how we are generating these diagrams |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In this PR I have added high-level diagrams representing the python-nomad codebase.
You can see how it is rendered in the Github markdown here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-nomad/on_boarding.md
Me and my friend are building these diagrams as we believe this is the best way to get up-to-speed with new codebase. We think getting high-level understanding of the codebase before diving into the part that interests you is crucisal hense the way we generate these diagrams. We leverage Static Analysis and LLMs and currenlty looking into Github actions so that you can always have up-to-date docs.
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.