Skip to content

Conversation

ivanmilevtues
Copy link

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.

  • The PR title starts with [$CATEGORY] (such as [NN], [Model], [Doc], [Feature]])
  • The PR is complete and small, read the Google eng practice (CL equals to PR) to understand more about small PR. In DGL, we consider PRs with less than 200 lines of core code change are small (example, test and documentation could be exempted).

Changes

Added docs :)

@ivanmilevtues ivanmilevtues changed the title [$Doc] [docs] Visualizing the dgl codebase Jun 28, 2025
@ivanmilevtues
Copy link
Author

Hey, a quick update on our side, we have released our diagram generation engine as an open-source repo: https://github.com/CodeBoarding/CodeBoarding

If you are interested to see how exactly we combined Static Analysis and LLMs you can head and see that there!

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.

1 participant