Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upDocumentation: Integrate odoc to generate documentation #122
Comments
bryphe
added
help wanted
good first issue
labels
Dec 19, 2018
This comment has been minimized.
This comment has been minimized.
|
cc @ostera |
This comment has been minimized.
This comment has been minimized.
|
@samatar26 (@bryphe, @samatar26 is a friend who is interested in helping out, he's a JS developer, new to reason), this might be a good issue for you to start with if you want to help out, might need to have a look at the docs for |
This comment has been minimized.
This comment has been minimized.
|
We've been also trying to research this for Brisk. It'd be great to use the same infra. |
This comment has been minimized.
This comment has been minimized.
|
Might want to have a look here on how to generate the docs in CI: https://github.com/esy-ocaml/hello-reason/blob/master/.ci/utils/create-docs.yml |
bryphe commentedDec 19, 2018
odocis a great OCaml-community-supported project for generating documentation - and it even integrates withesy. It'd be awesome if we could use it to generate some initial documentation.I imagine we'll need to do a better job of documenting in the files (using the proper code-block comments to get good descriptions in the documentations) - it'd be helpful to know what we need to do there to get high-quality docs.