Skip to content

Conversation

@ivanmilevtues
Copy link

Summary

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

The diagrams provide a high-level view of the project, showing key components and their interactions. Since many scientists and researchers use this codebase, they can quickly locate and understand the part relevant to their work. This helps them edit specific components with full pipeline context, especially as their focus is often on the methodology rather than the code itself.

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 (as part of your Sphinx /docs configuration).

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,

  • Unit tests provided for these changes
  • Documentation and docstrings added for these changes using the sphinx style

Changes

  • Added diagram visualization for the chemicalx project

@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