dialohq / ocaml-grpc

gRPC library for OCaml
https://dialohq.github.io/ocaml-grpc
BSD 3-Clause "New" or "Revised" License
62 stars 9 forks source link

Getting started documentation for ocaml-grpc #25

Closed tmcgilchrist closed 1 year ago

tmcgilchrist commented 1 year ago

Examples

Fixing the GRPC documentation one tutorial at a time.

TODO

Based off the Diátaxis framework for technical documentation writing.

quernd commented 1 year ago

Thank you for this initiative! This kind of tutorial was sorely missing. Given that we have an Eio port in the making that has feature parity with the Lwt implementation (we haven't battle-tested it yet), we can easily port this tutorial too so we can offer it in two flavors (or even three including Async).

tmcgilchrist commented 1 year ago

Testing the EIO version and writing up the code for that is on my list. Doing an Aysnc version is less interesting, I don't use it and have less experience with it. However it would not be that hard for someone else to do it if they want to.

wokalski commented 1 year ago

hey, amazing work. thanks for this!

tmcgilchrist commented 1 year ago

This is ready for review now @quernd and @wokalski

tmcgilchrist commented 1 year ago

Just a couple of nitpicks. I think we should just merge this PR after these small fixes. It will be good for visibility! Please don't forget to add your name to the list of authors :)

I've done the smaller fixes, so it is ok to merge.

The tutorial pages don't flow the way I would like but I can fix that up in another PR this week.