Skip to content

Added high-level diagrams#3

Open
ivanmilevtues wants to merge 1 commit intopfizer-opensource:mainfrom
CodeBoarding:main
Open

Added high-level diagrams#3
ivanmilevtues wants to merge 1 commit intopfizer-opensource:mainfrom
CodeBoarding:main

Conversation

@ivanmilevtues
Copy link
Copy Markdown

I generated a diagram representation of the LISTT codebase. YOu can see how the diagrams render here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LISTT/on_boarding.md

The idea of the diagram is to give people an easy way into the codebase. Showing what the main components are and how they interact with eachother gives a high-level understanding of how things work for new people. Then they can focus on the component of interest and start building their knowledge from there.

We’re generating these diagrams using a combination of static analysis and LLMs. We’ve also built a GitHub Action that you can add to any repository—it automatically updates the diagrams on every merge to main, release, or based on other heuristics.

We’d really love to connect and learn more about your needs—whether it's around onboarding, documentation, or helping people work more effectively with code. If you’re open to a quick chat, we’d be excited to explore how we can support your team.

@ivanmilevtues
Copy link
Copy Markdown
Author

Hey, a quick update on our side, this week we released our diagram generaiton engine as an open-source project! If you are interested to see more on how the generation works you can do so at https://github.com/CodeBoarding/CodeBoarding

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant