jannis-baum
Document API & architecture
Hey @Tweekism! I wrote the full-fledged API documentation in docs/api.md and would be happy about a review on that.
Additionally, I made a reasonably ugly draft for the documentation of the architecture of Vivify in docs/architecture.md based on your suggestion the other day that you could write that one. That's all the stuff I was thinking might make sense to document to give people an easier start into contributing to Vivify. Feel free to edit/rewrite that as much as you want, remove parts you think are obvious, and/or ask me if there is something missing/unclear :) Or also, if you think this is not necessary at all and/or you don't want to write it. No worries at all!
Thank you!!
When this is done I would ask you @tuurep to do the final review :)
The API stuff looks really good! I think that is a big help to anyone wanting to use the API. There is a couple things I could point at if you like, I'll do that as a review thing, but you could publish it as is honestly.
I'll start working on the architecture one as soon as I can. I'll go through it slowly and make sure I understand it as I add to it.