From aee95f66ff26e5871077f429b4d1fb271996825d Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 27 Jan 2025 11:54:57 +0100 Subject: [PATCH 1/5] doc: fix link to v21.3 changelog --- docs/releases/version-21.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/version-21.rst b/docs/releases/version-21.rst index e2d1d4177675..26a44a01240d 100644 --- a/docs/releases/version-21.rst +++ b/docs/releases/version-21.rst @@ -168,7 +168,7 @@ Check :ref:`the documentation ` for more details. Changelog --------- -- `Version 21.3 <../CHANGES.html#version-21-2>`_ +- `Version 21.3 <../CHANGES.html#version-21-3>`_ - `Version 21.2 <../CHANGES.html#version-21-2>`_ - `Version 21.1 <../CHANGES.html#version-21-1>`_ - `Version 21.0 <../CHANGES.html#version-21-0>`_ -- GitLab From 62febbaeedca9336ac4bc238c0ddc86301eaa3e2 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 6 Feb 2025 17:37:37 +0100 Subject: [PATCH 2/5] doc: add link to the single-file doc --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.rst b/docs/index.rst index aff55816e80e..ade7a45b9713 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -147,6 +147,7 @@ Platform developers are also provided reference materials for internal APIs of O
+You may also access this whole documentation as a single `text file `__. .. toctree:: :maxdepth: 2 -- GitLab From 8a168da39fb574c2936b25fda2cdc3e269614ffa Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 6 Feb 2025 17:52:10 +0100 Subject: [PATCH 3/5] doc: add link to source file for each page --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index f912d6fff22c..3163952c1419 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -134,6 +134,7 @@ html_theme_options = { 'use_issues_button': True, 'use_download_button': False, 'use_fullscreen_button': True, + 'use_source_button': True, } html_theme_options["analytics"] = { -- GitLab From 8401cfff03839313d38b71e926f6615ba6c24906 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 7 Feb 2025 18:49:17 +0100 Subject: [PATCH 4/5] doc: fix some broken links --- docs/conf.py | 1 + docs/developer/guidelines.rst | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 3163952c1419..4c3ec5a0bd56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -249,6 +249,7 @@ linkcheck_ignore = [ r'^http(s)?://localhost:\d+/?', r'^https://grafana\.nomadic-labs\.cloud/', r'^https://github\.com/jsonnet-bundler/jsonnet-bundler/', + r'https://github\.com/thierry-martinez/stdcompat/issues/13', # local files, e.g. ../api/api-inline.html#*', \.\./CHANGES.html#version-* # (interpreted by linkcheck as external links, generating false positives) r'^\.\./', diff --git a/docs/developer/guidelines.rst b/docs/developer/guidelines.rst index 9a44ca20514d..56374ff609d3 100644 --- a/docs/developer/guidelines.rst +++ b/docs/developer/guidelines.rst @@ -166,8 +166,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 `__. -In particular, it contains a `cheatsheet `__ that may be useful. +For more information on using docstrings, see the ``odoc`` `documentation for library authors `__. +In particular, it contains a `cheatsheet `__ that may be useful. Docstrings errors @@ -319,7 +319,7 @@ Fortunately, a few techniques may greatly increase the maintainability of commen * For instance, an externally-visble module exporting part of the functionality of some internal module(s) should describe each exported element, because users may not look to the internal module(s); but the internal modules should also describe their interface for their own users and maintainers. In such cases, duplication may be avoided by choosing a single place for the comments, and using cross-references to it wherever needed. - Fortunately, Odoc provides `such cross-references `__ and checks for each reference that the target element exists, ensuring they do not get stale when code is moved or suppressed. + Fortunately, Odoc provides `such cross-references `__ and checks for each reference that the target element exists, ensuring they do not get stale when code is moved or suppressed. * In other cases, the documentation needed near some piece of code is already available outside the code. For instance, a user-visible client command or node RPC should not duplicate explanations in the user reference. -- GitLab From b9cd5bdd73573b7ca848f1280705268d101428c7 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 13 Feb 2025 14:27:26 +0100 Subject: [PATCH 5/5] doc: insert link to DAL HW requirements --- docs/shell/dal_run.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index d0b43f55f161..d6ffe6c028e7 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -21,6 +21,8 @@ If the ``octez-node`` binary was not started with the ``--network `` ar Running the DAL node -------------------- +Before anything else, make sure your machine satisfies the hardware requirements at :doc:`dal_node`. + Follow these steps to run a DAL node along with a layer 1 node and a baker. #. **If** you plan to run the DAL node in **operator or observer** :ref:`profiles `, install the DAL trusted setup as described in section :ref:`setup_dal_crypto_params` (**NB:** just that section, not the rest of the page such as compiling sources, etc.). -- GitLab