[docs] Visualizing the dgl codebase #7890
Open
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.
Description
This PR gives a diagram of your python code (Static analysis + LLMs). You can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/dgl/on_boarding.md
The idea is to give high-level udnerstanding of contributors when they are starting on how the whole system works. So that they can have context when starting to work on their first issue - knowing how the small piece fits in the big picture!
I saw you have a docs pipelien if you like what you see I'd love to integrate it for you (also with our free github action to keep the docs up-to-date).
I usually open discussions, but they are not enabled for your repo. Any feedback is more than welcome!
Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.
Checklist
Please feel free to remove inapplicable items for your PR.
Changes
Added docs :)