Open kayceesrk opened 9 years ago
Would be a good idea to add documentation in the *.mli files in the style similar to https://github.com/mirage/irmin/blob/master/lib/irmin.mli. Then you can automatically generate doc pages like this: http://mirage.github.io/irmin/Irmin.html.
*.mli
Or on a more related topic, you can find inspiration in http://erratique.ch/software/react/doc/React https://github.com/dbuenzli/react/blob/master/src/react.mli
Would be a good idea to add documentation in the
*.mli
files in the style similar to https://github.com/mirage/irmin/blob/master/lib/irmin.mli. Then you can automatically generate doc pages like this: http://mirage.github.io/irmin/Irmin.html.