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

Documentation for tools to work with odoc #1135

Open
3 tasks
dlesbre opened this issue May 26, 2024 · 0 comments
Open
3 tasks

Documentation for tools to work with odoc #1135

dlesbre opened this issue May 26, 2024 · 0 comments

Comments

@dlesbre
Copy link

dlesbre commented May 26, 2024

The odoc doc is one of the first references I found when trying to write documentation for OCaml, its has good referencing and is easy to read. I believe it could be improved by presenting (or at least mentioning) the following:

  • having sherlodoc installed generates a search bar, this is a nice feature and extremely easy to use, but AFAIK it isn't mentioned anywhere in the docs.
  • mdx can be used to run odoc code blocks and check their output, thus ensuring you can't forget to update the documentation examples when updating the code.
  • the @doc-json target is useful to customize the output of odoc and integrate it in one's own website, it could do with more publicity both on the dune side (Better documentation for @doc-json dune#10557) and in the odoc docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant