From 933a2a3fa900b0ef70e699b699c2bdab8db4301e Mon Sep 17 00:00:00 2001
From: Nic Volanschi <nic.volanschi@nomadic-labs.com>
Date: Thu, 23 May 2024 16:30:05 +0200
Subject: [PATCH 1/3] doc: link to the odoc cheatsheet

---
 docs/developer/guidelines.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/developer/guidelines.rst b/docs/developer/guidelines.rst
index 00f2e0328031..6739e503662b 100644
--- a/docs/developer/guidelines.rst
+++ b/docs/developer/guidelines.rst
@@ -167,6 +167,8 @@ Here are a few tips and guidelines on using docstrings.
 - Docstrings in ``.mli`` and ``.ml`` files are handled the same, so do not omit documenting the interfaces in the latter files.
 
 For more information on using docstrings, see the ``odoc`` `documentation for library authors <https://ocaml.github.io/odoc/odoc_for_authors.html>`__.
+In particular, it contains a `cheatsheet <https://ocaml.github.io/odoc/cheatsheet.html>`__ that may be useful.
+
 
 Docstrings errors
 """""""""""""""""
-- 
GitLab


From 4652f68c15e180a37e83b542f18918be8d3adec8 Mon Sep 17 00:00:00 2001
From: Nic Volanschi <nic.volanschi@nomadic-labs.com>
Date: Thu, 23 May 2024 17:12:00 +0200
Subject: [PATCH 2/3] doc: explain where the OCaml APIs are published

---
 docs/README.rst | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/docs/README.rst b/docs/README.rst
index 18728f7ed5fc..60257a19076d 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -61,9 +61,7 @@ generated HTML pages are put in ``_build/<context>/_doc``.
 It creates one sub-directory
 per public library and generates an ``index.html`` file in each sub-directory.
 
-The documentation is not installed on the system by Octez. It is meant to be
-read locally while developing and then published on the www when releasing
-packages.
+The documentation is published online at :doc:`api/api-inline`.
 
 Writing documentation
 =====================
-- 
GitLab


From 0786a246bb37e4035e8a502ea35ad0530ccac9f2 Mon Sep 17 00:00:00 2001
From: Nic Volanschi <nic.volanschi@nomadic-labs.com>
Date: Mon, 27 May 2024 10:27:54 +0200
Subject: [PATCH 3/3] doc: fix docstring format in brassaia index_intf

---
 brassaia/index/src/index_intf.ml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/brassaia/index/src/index_intf.ml b/brassaia/index/src/index_intf.ml
index 0ed8d11e64c6..737db81c037e 100644
--- a/brassaia/index/src/index_intf.ml
+++ b/brassaia/index/src/index_intf.ml
@@ -248,8 +248,8 @@ module type Index = sig
   end
 
   module Value : sig
-    (** The input of {!Make} for values. The same requirements as for {!Key}
-        apply. *)
+    (** The input of {!Make} for values. The same requirements as for
+        {!module-Key} apply. *)
     module type S = sig
       include Value
       (** @inline *)
-- 
GitLab