[Docs] Diagram visualizaiton for the chemicalx project #111
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.
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
/docsconfiguration).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,
Changes