Visualization of the sample-app-aoai-chatGPT codebase

[ivanmilevtues]

Hey all,

I am Ivan and toghether with a friend we are working on helping people get up-to-speed with new codebases. I believe the idea of the sample-app-aoai-chatGPT is very similar. So I think would love to hear what different people in this community think of our project.

We believe that visualizations are the best way to get to know new codebase especially as a first step. This said we generate high-level diagrams using static analysis and LLMs. I generated one for the sample-app-aoai-chatGPT project: https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main/sample-app-aoai-chatGPT

Any feedback is more than welcome! Would love to hear what do you think about the diagram and diagram first documentation in general!

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.

[olishiz]

Thanks Ivan! I would like to know more about what you did with this repository. I would love to have an overview of what a new codebase looks like too! Because I am also facing the same problem and challenges in fact.

[ivanmilevtues]

I haven't worked with the this repo persay. We are working on generating diagrams, I've linked the one for this repo: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sample-app-aoai-chatGPT/on_boarding.md

If you want to have it in a more interactive way we also have a vscode extension, it's a tiny bit outdated compared to the latest developements, but you can try it: https://marketplace.visualstudio.com/items?itemName=Codeboarding.codeboarding

[ivanmilevtues]

Hey @olishiz we are open-source now, so you can take a closer look if intersted :)
https://github.com/CodeBoarding/CodeBoarding

[olishiz]

Awesome stuff my friend! Yes, I will test it out. Perhaps, you could hook it up onto an MCP server to expose these diagrams to the LLM inputs.

Just wondering, did you set a reload refresh page every 30 seconds to query for the status of the background process? What HTTP protocol did you use? Have you tried Streamable HTTP Protocol?

[ivanmilevtues]

Yes, we are polling the server-side! Just so you know we don't support TypeScript yet, so the quality of that generation might be hit or miss. This said TypeScript is next in line for support!