Diagram Visualization of the ProteinFlow's codebase #143
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.
With this change I am introducing a diagram visualization of the ProtenFlow codebase.
Me and a friend are working on this idea for automatic diagram driven documentation. As we believe that this is the best way to get to know a new codebase. The diagram documentation is targetted at contributors or people who want to play with the codebase, usually that starts with just one component. And we believe that having a high-level understanding of how the whole thing works gives context and allows people to dig deeper into the component of interest.
In this PR I have integrated our generation with your current documentation generation. As I know looking at plain html files is not fun, I ran the
bash dev/make_docs.shcommand locally and put the generation of docs on aws s3 so you can check it out:http://adaptyvbio-demo.s3-website.eu-north-1.amazonaws.com
And our visualization is here: http://adaptyvbio-demo.s3-website.eu-north-1.amazonaws.com/on_boarding.html
I am more than happy to collaborate and build something useful for everyone!
Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.