search

marigold-dev / pollinate

A platform agnostic library for P2P communications using UDP and Bin_prot
22 stars 2 forks source link

doc(odoc): init odoc #37

Closed Gau-thier closed 2 years ago

Gau-thier commented 2 years ago

The changes are directly within the *.mli files. I removed the generated *.html to our git repo, @rosalogia should I get rid of them and only add something like

To generate the doc, run:

$ dune build @doc

in our Readme.md?

ulrikstrid commented 2 years ago

I would strongly advice against adding the *.html files to the repo since they will change often and just add noise. You can setup publishing of docs to github pages instead.