ocaml-docs

Fix odoc documentation warnings and errors during OCaml dune builds.

46|6|Updated Jan 28, 2026
One-click install
npx skills add https://github.com/aresbit/MateBot --skill ocaml-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ocaml-docs
Source: https://github.com/aresbit/MateBot/tree/main/skills/ocaml/ocaml-docs
Command: npx skills add https://github.com/aresbit/MateBot --skill ocaml-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps fix odoc documentation warnings and errors encountered during dune builds, including issues with reference syntax, cross-package references, ambiguous references, hidden fields, and @raise tags.

Core Features & Use Cases

  • Guidance to resolve path-based odoc references using precise disambiguation syntax.
  • Step-by-step fixes for common odoc warnings, including cross-package and hidden-field issues.
  • Use cases cover large OCaml projects that generate documentation with dune and odoc.

Quick Start

Apply the ocaml-docs skill to address odoc warnings produced by dune build @doc in your OCaml project.

Frequently Asked Questions about ocaml-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix odoc warnings and errors during a dune build?

To fix odoc warnings during a dune build, correct reference syntax, resolve cross-package references, and address ambiguous references using path-based disambiguation. This skill provides step-by-step guidance for resolving these dune v3 documentation issues.

What is the correct syntax for cross-package references in odoc?

Cross-package references in odoc require precise path-based disambiguation syntax to resolve correctly. This skill enforces correct path-based references and provides guidance to resolve missing exports and disambiguate hidden fields across OCaml packages.

Does this skill support dune v3 syntax for OCaml documentation?

Yes, this skill supports dune v3 syntax for OCaml documentation. It is specifically designed for OCaml projects using the odoc tooling and dune build system to fix documentation warnings generated by dune build @doc.

How do I resolve ambiguous references and hidden fields in odoc?

To resolve ambiguous references and hidden fields in odoc, use precise path-based reference syntax. This skill provides targeted guidance to disambiguate references and properly expose hidden fields during OCaml documentation generation.

Why does my odoc build fail with @raise tag warnings?

Your odoc build fails with @raise tag warnings due to incorrect tag syntax or misplaced references within OCaml documentation. This skill helps fix @raise tags and other reference errors to ensure clean dune documentation builds.