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

•

学习与文档

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.

主要功能

Configures cross-package documentation dependencies within dune-project files.
Corrects @raise tag paths and provides proper character escaping for literal symbols.
Interprets complex odoc error patterns like unresolvedroot and ambiguous references.
Resolves odoc v3 path-based disambiguation syntax for precise referencing.
13 GitHub stars
Fixes 'Hidden fields' warnings through module re-exports and @canonical tags.

使用场景

Eliminating warnings and errors during the 'dune build @doc' process.
Migrating legacy OCaml documentation to the modern odoc v3 reference syntax.
Ensuring robust cross-linking between modules in complex OCaml monorepos.

关于

主要功能

Configures cross-package documentation dependencies within dune-project files.
Corrects @raise tag paths and provides proper character escaping for literal symbols.
Interprets complex odoc error patterns like unresolvedroot and ambiguous references.
Resolves odoc v3 path-based disambiguation syntax for precise referencing.
13 GitHub stars
Fixes 'Hidden fields' warnings through module re-exports and @canonical tags.

使用场景

Eliminating warnings and errors during the 'dune build @doc' process.
Migrating legacy OCaml documentation to the modern odoc v3 reference syntax.
Ensuring robust cross-linking between modules in complex OCaml monorepos.