ocaml
pkg: evaluate the documentation of `dune pkg` features and workflows
Up to this point, dune pkg and dune tools functionality has been inconsistently documented. Some parts have relatively thorough documentation (e.g, How Package Management Works while other parts or missing or incomplete (e.g, missing dune package fields in the dune-workspace.
We need to do an evaluation to determine what exactly we are missing, and then spawn sub-issues or small fixes to address the gaps.
Evaluation should include consideration of the structure of the documentation, and evaluation of the API being documented. I.e., while documenting the existing API we are likely to realize it has some obvious defects that can be remedied, and we should be sure to open issues to track these discoveries!
Some topics to keep in mind that may need to be added to docs or presented well in organization:
- Support for "avoid-version"?
- How to set up a CI pipeline using github actions and setup-dune
- How to cache dependencies between builds (I think @gridbugs has a solution for this)
Anything remaining to wrap this up, do you think? Or have all needed sub issues be spawned and the work fully discovered/planned?
Just merged the autolocking tutorial after incorporating the review comments so at the moment only https://github.com/ocaml/dune/issues/12797 remains and that is blocked on a new release of setup-dune.
I would like to do a pass of the documentation at some point and try to point out any missing docs or places for improvement.
