Visualization of the poetry codebase #10436
ivanmilevtues
started this conversation in
Show and tell
Replies: 1 comment
-
A quick update, our generation engine is now open source: 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, I generated via static analysis and LLMs diagram representation of the poetry's codebase:
You can check it out here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/poetry/on_boarding.md
The diagram is designed to give a high-level overview of the codebase by providing the main components and how they interact with eachother. With this information a new contributor can start their first task by understanding how what they are editing fits in the big picture. I'd love to hear what is your opinion on diagram first documentation.
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. Also as many people brought that the diagrams will become outdated fast, we've introduced free github action!
Beta Was this translation helpful? Give feedback.
All reactions