Skip to content

Conversation

@ivanmilevtues
Copy link

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.sh command 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.

@ivanmilevtues
Copy link
Author

Quick note, the new workflow requires a Personal Access Token with access to repo and workflow.

It has to be added in the resposiotry secrets in the Action's section with the name of PAT_TOKEN

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