Visualization of the nicegui codebase

[ivanmilevtues]

Hey all,

I am Ivan and toghether with a friend we want to improve the process of documentation for contributors. We believe in visuals so think that there is lots of value in diagram first docs.

This said we are building abstract/high-level diagram generation for projects, I generated one for this codebase:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nicegui/on_boarding.md

As we know that LLMs are flawed we leverage static analysis alongside the LLM to generated the diagrams. I would love to hear what do you think of the idea of diagram first documentation?

Any feedback on the diagram and in general is more than welcome!

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.

[evnchn]

Content-wise, I think it is decent enough (LLMs will only get better, so it will only get more better)

But, I think the onboarding lacks a "human touch". In a "real" onboarding, I expect no less than a virtual Falko talking me through the important bits of the codebase, and your onboarding lacks that feeling. You must watch https://youtu.be/D5DnLgeObq4?si=kBBgTWWqDW7Z6M7Q

That's the dealbreaker: LLMs willl get smarter as they are engineered to perform in the benchmarks, but the feeling of whoever reading their output may or may not get better.

I know feelings are hard to optimize, but (1) it's a consensus thing, try invite more feedback, and (2) perhaps another LLM agent can judge the "human touch-ness" of the onboarding document and adjust from there?

[ivanmilevtues]

Thank you so much for the response, I just added the video in my to watch. We are trying to get more and more feedback and I am writting all of it down, so in the next week we will be mainly building and improving on the recieved feedback ❤️.

The walkthrough part is something that we are looking to have in VSCode as we are also building an extension which has the same diagram on the left and then it can imideatly open the source code on the right:

In that case we think it would be amazing to have some sort of a walkthrough.

Further we lean on the idea that with the generation one can have always up-to-date documentation, and currently looking into creating a GitHub action which people can use in their public repos for free.

[evnchn]

The VSCode extension looks great. It is better than trying to open another wiki page (as you know VSCode don't really work well, when it only has half of the screen, so yeah)

Do let us use it for free if possible 😆

[ivanmilevtues]

Thanks, we will probably release it soon and it will most probably be free for public repositories and payed for people who care about privacy (sharing they code with the big LLMs).

I will comeback and link it here as you seem interested 🎉

[rodja]

Do you guys know about https://deepwiki.com/zauberzeug/nicegui/?
It seems to be in the same ballpark as your solution and I find it super impressiv.

[ivanmilevtues]

Thank you for the comment @rodja, we know about deepwiki, but we believe that documentation should be diagram-first. Further we think that what we have has to be very dynamic and part of most IDEs as the one I linked in the comment above :)

This said for it to be interactive it has to work fast and on all levels, not just on the highest level of abstraction, we want it to be a new way to navigate a codebase. I would love to hear what you think about that as well :)

[ivanmilevtues]

Hey, wanted to drop by and quickly mention that we are now open-source if interested you can check our repo: https://github.com/CodeBoarding/CodeBoarding

[evnchn]

[ivanmilevtues]

We will improve this, it is not clear now. We are expecting the full url -> https://github.com/zauberzeug/nicegui