Adding diagram documentation #4909
Closed
brovatten
started this conversation in
Feature Suggestions
Replies: 1 comment
-
|
Hi @brovatten . Thanks for your proposal and the sample! |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hi,
I'd like to propose integrating CodeBoarding into your documentation.
It's an open-source code visualization project I am working on. It helps contributors and users better understand the repositoryβs structure. CodeBoarding uses static analysis and an LLM pass to generate accurate, interactive diagrams that show the high-level architecture and allow drilling down into specific modules or functions.
Given the complexity of
python-telegram-botand large flow of new users and contribuots, these diagrams could be incredibly for onboarding or code reviews. I've generated a sample diagram for this repo so you can see what it looks like:https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-telegram-bot/on_boarding.md
If you think this would be a good addition, Iβd be happy to open a PR that integrates this visualization into the documentation. Thanks in advance.
Beta Was this translation helpful? Give feedback.
All reactions