Visualization of the python-asana codebase #212
+684
−0
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 contains high-level diagrams representing the codebase of the python-asana repository.
You can see how it renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-asana/on_boarding.md
The goal of these diagrams is to give high-level understanding of the full project at a glance. And then one can get into details much easier about different components of the project. The way I generate these is based on Static Analysis and LLMs.
I would love to hear what your process for on-boarding in Asana is, what is your opinion on diagram first documentation?
In order to keep these docs update we are working on a github action at the moment. Let me know if this sounds like something interesting.
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.