Visualization of the DocsGPT codebase

[ivanmilevtues]

Hey all,

I have generated an abstract diagram for the DocsGPT codebase. You can check it here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/docsgpt/on_boarding.md

Me and a friend have recognized that it never is easy to get started with new codebases, so we thought that visualization is always the best starting point. This said for code that is abstract high-level diagrams in our opinion, and whenever you want to get more in-depth knowledge you can go into the component which you find interesting. We also believe that the best docs are the ones which are up-to-date, so this is why we wanted to generate them. As everyone know that LLMs can be unrelyable and hallucinate we use Static analysis with combination of LLMs to fight this problem.

I would love to hear your feedback on the diagram and generally what do you think about on-boarding do you think diagram driven documentation is the way to go?

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.

[aalghooneh]

Hey, thanks for asking my opinion on this, I'm gonna definitely use your product.

Here's my take short,

Three strengths

1. Instant big‑picture view – single‑screen Mermaid graph orients newcomers in seconds.
2. Clickable nodes – links jump straight to deeper docs, shortening lookup time.
3. Static‑analysis source – auto‑generated, so the diagram stays current and trustworthy.

Three improvements

1. Add one middle layer – insert “service” clusters to bridge high‑level boxes and raw class lists.
2. Differentiate edges – use arrow styles/colours to show sync vs async or data vs control flow.
3. Include a tiny “first task” box – e.g., “Run locally → make up”, to guide readers from map to action.

[ivanmilevtues]

Thank you so much for the feedback, awesome to hear you think we are on the right track!
If you want to generate something for your own project you can try our demo: https://www.codeboarding.org/demo (note for now it works just for python)

I have written down the suggested improvements and I am sure we will have some good news for you next week!

[ivanmilevtues]

A quick update on my side we are now open-source: https://github.com/CodeBoarding/CodeBoarding
@aalghooneh you can take a look if interested

[dartpain]

Its actually quite cool, I wish graphs in our repo where a bit more simplified tbh.

[ivanmilevtues]

Hey @dartpain we have updated a lot of things since the version I sent. I just updated it (same link), you can check it here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/DocsGPT/on_boarding.md

Let me know what you think of it now. If you like it I can make a PR which will include it and our github action to keep it up-to-date once per week :)