Skip to content

Conversation

@ivanmilevtues
Copy link

@ivanmilevtues ivanmilevtues commented Jul 4, 2025

In this PR I am introducing diagram first documentaiton. You can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bioblend/on_boarding.md

The diagrams provide a clear overview of the project's main components and their interactions, helping scientists and researchers quickly locate and edit the relevant parts of the codebase within the full pipeline context. Since most researchers focus on the methods rather than the code, this gives efficient navigation and understanding.

Any feedback is more than welcome! We have introduced a github action which will keep the docs automatically up-to-date with new changes, I'd love to integrate that for you if you are interested.

Would love to connect and discuss how we can help!

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 ivanmilevtues changed the title Added high-level diagrams [Docs] Diagram visualization for bioblend Jul 4, 2025
@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