search

OCamlverse / ocamlverse.github.io

Documentation of everything relevant in the OCaml world
https://ocamlverse.net
Creative Commons Zero v1.0 Universal
177 stars 67 forks source link

OCaml Quick Reference #11

Open pmetzger opened 6 years ago

pmetzger commented 6 years ago

Suggested short project: short summary of the language and tools, intended for beginners (or non-beginners) who are having trouble remembering one small thing (say, "what was the syntax of GADTs again" or "what's the difference between all the .c?? file types again?)

This should not present any of the language grammar as the grammar is too intricate to follow in most cases.

If this got good enough, it could become part of the official OCaml docs.

pmetzger commented 6 years ago

Possible source of some content: https://ocaml.org/docs/cheat_sheets.html

pmetzger commented 6 years ago

Apparent sources: https://github.com/OCamlPro/ocaml-cheat-sheets

bluddy commented 6 years ago

I see the most utility in the language cheat sheet. With regard to tools, the lack of support for Dune, opam etc due to the date these were made is an issue. Possibly the same problem exists with the stdlib pdf. We could include it in the learning page.

pmetzger commented 6 years ago

All of this will quite clearly require updates, yes.

bluddy commented 6 years ago

OPAM could really use this. As I discovered from a discord discussions, many useful commands are missing such as eval $(opam config env --switch=SWITCH) for a local shell session in a particular switch.

Once OPAM 2.0 takes off, we can transition entirely to those commands.

Also, sorry for my comment above -- I skimmed over your proposal and somehow interpreted it to mean we should just link to those pdfs, which was way off.

This may even justify a quickref folder separate from learning (or perhaps inside learning). It could grow to support more and more libraries, in terms of getting things started quickly.

The more I think about this idea, the more I like it.

bluddy commented 6 years ago

May I also suggest that the quick reference section be linked to from the main page. We want it to be as easily accessible as possible.