Code documentation for the scispacy project

[ivanmilevtues]

This PR contains diagrams for the scispacy codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/scispacy/on_boarding.md

The scispacy codebase is loved by a lot of scientists. This said I am sure many of them want to add small modification to the codebase/understand it better. The goal of this PR is to help that process. We believe that visuals give immedaite context on a new person, and they can focus on the module (component) which interests them. I would love to hear what do you think about diagram first documentation for on-boarding and if it fits in your existing on-boarding processes.

Any feedback is more than welcome! We also have a free github action out now, which can automatically updated the docs (let me know what you think about that)

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.

[laulopezreal]

Very nice, I´ve always missed a diagram like this in the project. I wish I have seen it when I first started using scispacy.

[ivanmilevtues]

@laulopezreal, thanks! It means a lot that you find it useful. I'd love to get connected and discuss if you want to use such thing in your day-to-day. We also have a VSCode extension, lmk we can connect via linkedin or somewhere else!

[ivanmilevtues]

A quick (and exciting) update from our side, we are now open-source as well. If you are interested to see how exactly we do those generations you can do so at: https://github.com/CodeBoarding/CodeBoarding

@laulopezreal I suppose this might interest you <3