Does this skill support the latest odoc v3 syntax?

Yes, it specifically focuses on modern path-based disambiguation, such as using {!Path.To.kind-Name} instead of the older prefix-based syntax.

How does it handle literal @ symbols in documentation?

It provides the correct escaping patterns (e.g., using \@) to prevent odoc from misinterpreting literal characters as documentation tags.

How do I fix 'Hidden fields' warnings in my OCaml docs?

The skill provides two primary methods: re-exporting the missing module in your wrapper .mli file or using the @canonical tag to link to the correct type location.

Can it help with references to modules in other packages?

Yes, it provides the correct stanza for adding documentation dependencies in your dune-project file to ensure odoc can resolve external roots.

OCaml Documentation Expert

Name: OCaml Documentation Expert
Author: avsm

byavsm

•

Learning & Documentation

Fixes and optimizes OCaml odoc documentation by resolving syntax warnings, cross-package references, and ambiguous identifiers.

The OCaml Documentation (odoc) skill provides specialized guidance for maintaining high-quality API documentation within OCaml projects. It focuses on resolving complex warnings generated during 'dune build @doc', specifically targeting the latest odoc v3 standards. By utilizing path-based disambiguation, managing cross-library module exports, and handling tricky @raise tags or escaping rules, this skill ensures that your OCaml documentation is both technically correct and fully navigable. It is an essential tool for developers managing multi-package repositories who need to maintain clear, hyperlinked documentation across diverse module boundaries.

Key Features

01Configures cross-package documentation dependencies within dune-project files.

02Corrects @raise tag paths and provides proper character escaping for literal symbols.

03Interprets complex odoc error patterns like unresolvedroot and ambiguous references.

04Resolves odoc v3 path-based disambiguation syntax for precise referencing.

0513 GitHub stars

06Fixes 'Hidden fields' warnings through module re-exports and @canonical tags.

Use Cases

01Eliminating warnings and errors during the 'dune build @doc' process.

02Migrating legacy OCaml documentation to the modern odoc v3 reference syntax.

03Ensuring robust cross-linking between modules in complex OCaml monorepos.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add avsm/ocaml-claude-marketplace ocaml-docs

For use in Claude.ai and ChatGPT

Download Skill