Suggestions for ocaml documentation

Just some information about the PR to ocaml.org mentioned above. This PR is abandonned, it did not raise enough interest, maybe too big, or maybe just bad.
Instead I’ve recently proposed a much smaller PR https://github.com/ocaml/ocaml.org/pull/1124
which is just a new arrangement of the docs page, with links to the existing manual (which now resides in https://ocaml.org/releases/).

On the other hand the work on the manual itself continues, on https://sanette.github.io/ocaml-tutorial/index.html
I’m happy to announce that, although it first started only with Part I (Tutorials), it should now contain the whole manual. Of course it’s difficult for me to check every page of it, so comments are welcome!

10 Likes

That is awesome! Thanks.

Please do not give up, it is a huge improvement over the official manual. I personally keep a mirror of your pages locally for offline use, the API search is pure gold!

What if, for now, we check if this can be integrated into the ocamlverse. @bluddy what do you think?

6 Likes

I’d have no problem trying to integrate it, but I think integrating into the site’s jekyll structure could be painful, and since the docs would be in a corner of the site, they wouldn’t be as easily available.

@sanette, why not create an organization on github: say, ocamlapi? Migrate your repo to this organization. You’d then have the site ocamlapi.github.io which would be easy to find (and bookmark). I have to mention that I also love what you’ve done with the docs, including the API search stuff.

1 Like

@bluddy, @mseri, many thanks for your support. Don’t worry I’m not giving up :wink: As I said in the first PR, my ambition is to integrate this post-processing into the ocaml/manual dev. If this fails I’d be happy to try your suggestions.

4 Likes

Here is the proposal to integrate the new manual + API into the official manual “pipeline”:

Feel free to comment this PR if you have suggestions for improvements.

4 Likes