ocaml / ood

OCaml.org v3 data repository
Other
14 stars 8 forks source link

import academic data #37

Closed shreyaswikriti closed 3 years ago

shreyaswikriti commented 3 years ago

Imported contents from teaching-ocaml page.

patricoferris commented 3 years ago

Thanks for the PR @shreyaswikriti, this all looks really good from a quick glance. The CI is failing because the code has not been formatted (although to be fair we don't say anywhere that it must be formatted). Could you reformat the code, commit it and push to this branch again?

To format the code you will need to install ocamlformat opam install ocamlformat.0.15.0 and then from the root of the project you can run dune build @fmt --auto this will run the formatter and automatically replace the unformatted lines of code with formatted ones. This should fix the failing step in the CI and then we can get to the lint checks to make sure the data is all working nicely :))

tmattio commented 3 years ago

This is great, thanks @shreyaswikriti!

I don't see any markdown in the document, only the metadata. Is there a reason to add the data as markdown documents, as opposed to a standalone Yaml file?

patricoferris commented 3 years ago

I suggested to do the markdown format, the idea is that I would quite like institutions to add comments about OCaml and how they use it, we just don't have this information yet (similar to what the markdown is used for in the industrial users section).

patricoferris commented 3 years ago

Awesome all tests are green, thanks @shreyaswikriti! 🎉