Skip to content

Commit

Permalink
Add reference notice on release plans in the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mbarbin committed Oct 12, 2024
1 parent df41d90 commit edb718c
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions doc/docs/reference/odoc.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
# OCaml Packages Documentation

You can view the published odoc pages here: [https://mbarbin.github.io/cmdlang/odoc/](https://mbarbin.github.io/cmdlang/odoc/).

## Release status

### Pending releases

We plan to release the following packages soon to allow interested parties to experiment with cmdlang and provide early feedback.

| package | released to opam |
|----------------------|:----------------:|
| cmdlang.opam | pending |
| cmdlang-to-cmdliner | pending |
| cmdlang-to-climate | pending |

### Planned releases

| package | released to opam |
|----------------------|:----------------:|
| cmdlang-to-base | planned |

We also plan to release the translation to `core.command`. However, this will require additional work. Specifically, we aim to complete the coverage of that part of the code and exercise the translation using special configuration options in a tutorial.

### To be determined

| package | released to opam |
|---------------------------|:----------------:|
| err | TBD |
| err-cli | TBD |
| cmdlang-cmdliner-runner | TBD |

These packages are more experimental and opinionated in nature. They will require further consideration and potential redesign before being released.

0 comments on commit edb718c

Please sign in to comment.