Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document site #30

Open
smorimoto opened this issue Nov 5, 2021 · 3 comments
Open

Document site #30

smorimoto opened this issue Nov 5, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@smorimoto
Copy link
Member

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 smorimoto added the documentation Improvements or additions to documentation label Nov 5, 2021
@smorimoto
Copy link
Member Author

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

@balat
Copy link
Member

balat commented Nov 8, 2021

@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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants