Skip to content

Conversation

ivanmilevtues
Copy link

This PR contains documents with mermaid diagrams which represent the codebase on a high-level. You can see how they are rendered here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/aizynthfinder/on_boarding.md

The idea of these documents is to help people get up-to-speed with the aizynthfinder codeabse. Me and a friend are working on helping the get-to-know phase for people who interact with code. I am sure that in MolecularAI (AstraZeneca) there are a lot of scientists who use code mainly as a tool and are not SWE, I would love to get to know if such diagrams can be useful for such people. Further what is your current onboarding process, do you think such automated diagram first documents can be part of it?

We are generating these diagrams with the help of Static Analysis and LLMs.

Any feedback is more than welcome! We already have a github action which I can integrate within this repository and it will update the diagram as development happens!

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.

@ivanmilevtues
Copy link
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant