Diagram representation of the LaTeX-OCR codebase #426
Closed
ivanmilevtues
started this conversation in
Show and tell
Replies: 1 comment
-
Hey, happy to update you that we are open-source now as well. If you are interested to get better idea of how the generation works you can do so here: 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.
-
I have generated high-level diagrams for the LaTeX-OCR project. You can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LaTeX-OCR/on_boarding.md
The diagrams aim to give an overview of the codebase for new people and then they can focus on what interests them. When the dive deeper in the component of interest now they have the context of how it interacts with the rest of the codebase. Knowing you have more than 1.2k forks, there are a lot of people who are playing with the codebase itself. I wonder if you agree that this could be something useful for them and also you internal team of maintainers!
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
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