Hi All, I’m new to learning OCaml and also new to this forum. I am really enjoying learning OCaml, but there’s a lot of quirks and weird things since I feel like a lot of things are in transition right now, but one thing that really bugged me was how outdated the docs on the standard library looke…

It’s neat! Docs were actually recently revamped and made very nice, but I must admit that made it even nicer (though this is a matter of taste, and there might be people who may not share my feelings). But I’m with a greedy interest here, will you share the source code? :wink:

Thanks. Yes, the source code is here: https://github.com/seadynamic8/ocaml-modern-docs (It’s already included on the homepage of the docs) Sorry, the code could be better. And no tests, maybe i’ll add some later.

nice! it would be even better imo if the Top entry in each top-level module in the register would be merged into the module heading, so that clicking e.g. on List directly shows something in the main panel.

Thanks. The reason for the “Top” entry is so that you can look into other modules list of functions without losing your spot. Sometimes you want to just do a quick comparison with other modules function lists. I did weigh the benefits of that design decision though. It certainly is quicker to ha…

This is a fine thing. I’m not sure all the aesthetic choices are what I’d prefer but that’s a quibble. You might want to download the OCaml sources and look at how the docs now look in the trunk of the git repository, they’ve changed a bit, and you might want to do some pull requests. Note that some…

Thanks. Yea, I’m not expecting everyone to agree with aesthetic choices, but I just did it out of frustration of how the standard docs looked and worked. I still think regardless, it looks and works better than the official one, but its just something I wanted to share, if people want to use it or…

[image] seadynamic8: I just did it out of frustration of how the standard docs looked and worked. You are not the only person who would like the documentation to look better, and help in making the official stuff be more readable and modern is actively welcome I think. Several of us made the …

You are not the only person who would like the documentation to look better… Several of us made the docs significantly better for 4.07 than they were for 4.06 (don’t laugh, they’re much better) and having them better still for 4.08 would be a very good thing. I wasn’t aware of that. Sorry, I did…

[image] seadynamic8: Sorry, I didn’t mean to offend, but I just wanted to make them better. You offended no one, and your efforts are appreciated. We’re not working on it nearly hard enough, more help is appreciated. [image] seadynamic8: I just feel that me being new to the community and…

I didn’t see anyone mentioning it yet, but odoc is the tool that will eventually be used for all library documentation, including the standard library. The odoc folks might appreciate your help in improving the tool further.

Modern Standard Library Documentation

Ecosystem

seadynamic8 November 14, 2018, 2:54pm 15

@perry ok, I understand.

Topic		Replies	Views
OCaml Documentation Open Thread Ecosystem	148	10712	October 13, 2018
Suggestions for ocaml documentation Community documentation , ocamlorg	84	7691	July 16, 2020
Why the OCaml ecosystem is poorly documented? Community	61	3397	January 29, 2025
New pages for OCaml API Community	39	3098	March 28, 2020
Future of the OCaml documentation pages? Community	10	2232	November 30, 2017

Modern Standard Library Documentation

Related topics