You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Sketch a very high-level view of what is involved in publication and maintenance
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].
The text was updated successfully, but these errors were encountered:
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
Uh oh!
There was an error while loading. Please reload this page.
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].
The text was updated successfully, but these errors were encountered: