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

opam.ocaml.org should make it easier to find package documentation. #2349

Open
patrick-nicodemus opened this issue Apr 16, 2024 · 0 comments

Comments

@patrick-nicodemus
Copy link

patrick-nicodemus commented Apr 16, 2024

Currently, the page at https://opam.ocaml.org/packages/core (substitute your favorite OCaml package here) does not contain any kind of links or pointers to documentation.

Say I want to find documentation on OCaml package packagename. I will often Google "ocaml packagename" or "opam packagename". Frequently the first link that I find is to https://opam.ocaml.org/packages/mypackage/.

It is not clear imo from browsing https://opam.ocaml.org/ where one should look for documentation for any of the packages listed on this site, one cannot interactively discover the page ocaml.org/p/packagename or any hint that all the documentation for all of the packages is hosted on a totally different part of the website. Ideally, https://opam.ocaml.org/packages/mypackage should link prominently to ocaml.org/p/mypackage, perhaps also opam.ocaml.org should link to ocaml.org/packages.

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

No branches or pull requests

1 participant