[Docs] Visualization of aizynthfinder's codebase. #186
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.