Visual map for the python-facebook codebase #278
Closed
ivanmilevtues
started this conversation in
Show and tell
Replies: 1 comment
-
Happy to announce that we are now open-source at: https://github.com/CodeBoarding/CodeBoarding |
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.
-
Hey all,
Me and a friend are building something to help both maintainers and contributors to have always up-to-date code docs. We are doing this with the idea to help people get up-to-speed with new codebases. We believe that at the begining of our contribution journey the best resources are visuals. So that is why with static analysis and LLMs we are generating high-level diagrams. And here is the one for python-facebook: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-facebook/on_boarding.md
I would love to hear what is your opinion on diagram first documentation! Further any feedback is more than welcome!
If you think that such diagrams can be useful for your repo I would be more than happy to create a PR!
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.
Beta Was this translation helpful? Give feedback.
All reactions