There’s a lot of stuff that isn’t currently being documented in the OCaml world. Much of it has to do with the ecosystem, what libraries are good, which ones exist, which ones have issues, where to focus
developer attention etc. Awesome OCaml does some of this, but
is hard to maintain via github. Other things that need to be properly documented are compiler internals, easy-find-links to good articles etc. Then there are many things I haven’t even thought of that need to
I’m a firm believer in feedback loops and incrementalism: I think once some things are documented, more and more will be as well, and that this will encourage more community growth. In that spirit, I’ve
created a documentation site called ‘OCamlverse’ at https://ocamlverse.github.io to attempt to meet these demands. Again, it’s entirely possible that this will fail - hence the point of calling this an experiment - but I hope it won’t.
Good static content may be copied gradually to
www.ocaml.org. There are some guidelines to pay attention to, posted here. Discussion channels for making large changes are in the issues/PRs of the repo, and on the discord server in the #ocamlverse channel.
Now go forth and document stuff!
Q: Why this and not ocaml.org?
A: ocaml.org is the public face of OCaml to the world. It cannot tolerate rapid changes, partial improvements, multiple sections leading to other sections, experimental partial reorganization etc. It needs to look good. OCamlverse prioritizes contents over looks.
Additionally, just about anyone can become a maintainer on OCamlverse. Just follow the contribution guidelines, make small changes as you wish, medium changes with a post to the discussion channels, and large changes using PRs, and try to make this a comprehensive documentation resource for OCaml. Post your github handle here and you too will become a maintainer. I hope it’s clear that the same process cannot work for ocaml.org.
EDIT: The original idea was to use a real wiki, but I’ve since been convinced to switch over to a more git-based workflow, and the updated post reflects that.