Skip to content

Add conspicuous and concise explanation about the nature of the opam-repository #27796

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

Open
shonfeder opened this issue Apr 19, 2025 · 0 comments

Comments

@shonfeder
Copy link
Contributor

shonfeder commented Apr 19, 2025

This issue is to address @ejgallego's question at Deducteam/lambdapi#1229 (comment)

While there is existing documentation about packaging, publishing packages, and working with the CI results on package publication PRs, there is not a single, concise, high-level explanation of how the opam-repository works from a package author perspective, and why it works as it does.

Here is the existing documentation I know of, along with a note about why it doesn't meet the stated need:

What we are lacking, AFAICT, is a single, highly visible and easily accessible document that covers the following points:

I think we can adequately explain each of these points in one or two short paragraphs, and then link to the more detailed documentation noted above.

I would propose that this kind of high-level explanatory material would be a good fit for a section on the [./README.md][https://github.com/ocaml/opam-repository/blob/master/README.md].

@shonfeder shonfeder changed the title Add conspicuous and concise documentation of the nature of the opam-repository Add conspicuous and concise explanation about the nature of the opam-repository Apr 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant