Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Question about OCaml Compiler Packages #24789

Open
sabine opened this issue Nov 14, 2023 · 2 comments
Open

Question about OCaml Compiler Packages #24789

sabine opened this issue Nov 14, 2023 · 2 comments

Comments

@sabine
Copy link
Contributor

sabine commented Nov 14, 2023

What I've seen:

It would be very helpful to have both a comprehensive list of all compiler packages and to make their documentation available through OCaml.org so people can benefit from in-package documentation search on the OCaml.org package pages.

For this, every compiler-related opam package should be published in such a way that the documentation builds with odoc.

@raphael-proust
Copy link
Collaborator

Stdlib is not distributed as an opam package. We worry that adding an "empty" package for documentation only would create confusion and complication.

The easiest way to detect that a package is an ocaml compiler is if it has the flags: compiler entry in the opam package. Would it be possible to special case packages with this field to be given the name "Stdlib" on the documentation index?


The base-unix package is actually not useful anymore. We are thinking about what would be a reasonable way to transition it out of the repository.

@sabine
Copy link
Contributor Author

sabine commented Nov 24, 2023

As far as I understand, the ocaml-base-compiler packages contain much more documentation than just that of the standard library, which is quite unfortunate for search purposes.

We would have to limit the search results in some way to just those that https://ocaml.org/releases/latest/api/index.html provides, to get a good UX.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants