search

ocsigen / ts2ocaml

Generate OCaml bindings from TypeScript definitions via the TypeScript compiler API
Apache License 2.0
172 stars 8 forks source link

Document site #30

Open smorimoto opened 3 years ago

smorimoto commented 3 years ago

Finally we have bootstrapped this, it's definitely better to have an odoc-based documentation site if we rewrite this to OCaml in the future, but for now this is still F#. So I think we need an Ocsigen-style documentation site with WikiDoc. That said, I'm not really familiar with it.

smorimoto commented 3 years ago

@balat Could you help me set it up? I think it's great to have that before the release.

balat commented 3 years ago

@smorimoto I just saw your message. To have the documentation on the web site, take as example another project (for example Ocsigen Toolkit). Create a git branch wikidoc for the documentation. We usually have a manual written in wikicreole syntax, and the API documentation, generated by ocamldoc with an extenion to generate wiki files. Then we need to set up github action for converting wiki to html. See: https://github.com/ocsigen/ocsigen-toolkit/blob/wikidoc/.github/workflows/siteupdate.yml See also: https://ocsigen.org/home/contributing.html

Don't hesitate ta ask for more help. I'll help you to update the main menu to add ts2ocaml.

smorimoto commented 3 years ago

@balat Thank you for showing me that! It looks fairly easy, so we will try that!