From cfeeedc8f3c2246d41b35ade760db5e8c0c3061b Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 7 Nov 2025 15:46:39 +0100 Subject: [PATCH 1/8] doc: capitalize remaining "layer 2" --- docs/releases/version-18.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/version-18.rst b/docs/releases/version-18.rst index d91309997a0e..b9df65d54609 100644 --- a/docs/releases/version-18.rst +++ b/docs/releases/version-18.rst @@ -82,7 +82,7 @@ You can also install Octez using Opam by running ``opam install octez``. - :package-api:`octez-libs `: Contains the base libraries for Octez. - :package-api:`octez-shell `: Contains the Octez shell related libraries. - :package-api:`octez-proto-shell `: Contains the Tezos protocol dependent libraries. - - :package-api:`octez-l2-libs `: Contains the layer 2 related libraries. + - :package-api:`octez-l2-libs `: Contains the Layer 2 related libraries. - For each protocol ``P`` - :package-api:`octez-protocol-P-libs `: The protocol ``P`` dependent libraries. - ``tezos-protocol-P``: The Tezos protocol ``P`` itself. -- GitLab From e9036ba67fe001a6113c6f42a93c5ec0d82d0a6e Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 7 Nov 2025 16:14:04 +0100 Subject: [PATCH 2/8] doc: more precise link to triggering_execution_outbox_message --- docs/alpha/smart_rollups.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/alpha/smart_rollups.rst b/docs/alpha/smart_rollups.rst index 9e38194a01f9..054b14217847 100644 --- a/docs/alpha/smart_rollups.rst +++ b/docs/alpha/smart_rollups.rst @@ -261,8 +261,8 @@ concurrent commitment for the same commitment period to force the removal of the invalid commitment. If no one posts such a concurrent commitment during the refutation period, the commitment can be cemented with a dedicated operation injected in Layer 1, and the -outbox messages can be executed by the Layer 1 by an explicit Layer 1 -operation (see :doc:`../shell/smart_rollup_node`), typically +outbox messages can be executed by an explicit Layer 1 +operation (see :ref:`triggering_execution_outbox_message`), typically to transfer assets from the rollup to the Layer 1. Note that such withdrawals are possible during a limited time after cementation, given by the protocol constant ``smart_rollup_max_active_outbox_levels``, which currently corresponds to about 10 days. -- GitLab From 7893388935b706cd619cdcf5d8b4bef558ca405d Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 10 Nov 2025 10:13:27 +0100 Subject: [PATCH 3/8] doc: fix command to run protocol tests --- docs/developer/proposal_testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/proposal_testing.rst b/docs/developer/proposal_testing.rst index 62d35163f1e2..b66427a622fc 100644 --- a/docs/developer/proposal_testing.rst +++ b/docs/developer/proposal_testing.rst @@ -16,7 +16,7 @@ To run the protocol tests you must work in a clone of the Octez repository, in w You can run the tests for any protocol whose sources are in a subdirectory of the form ``src/proto*/``. For example, you can perform the protocol tests on protocol Alpha as follows:: - dune run tezt src/proto_alpha/lib_protocol/test + dune runtest src/proto_alpha/lib_protocol/test You can execute only tests located in a particular subfolder, for example consensus-related tests:: -- GitLab From 2b7c3d2b171e38815e68ca27e89ef9479b785d0e Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 18 Nov 2025 16:18:05 +0100 Subject: [PATCH 4/8] doc: explain difference between dune runtest and dune exec --- docs/developer/proposal_testing.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/developer/proposal_testing.rst b/docs/developer/proposal_testing.rst index b66427a622fc..dbcd1c858855 100644 --- a/docs/developer/proposal_testing.rst +++ b/docs/developer/proposal_testing.rst @@ -18,11 +18,15 @@ For example, you can perform the protocol tests on protocol Alpha as follows:: dune runtest src/proto_alpha/lib_protocol/test -You can execute only tests located in a particular subfolder, for example consensus-related tests:: +You can execute only tests located in a particular subfolder, for example consensus-related tests this way:: + + dune runtest src/proto_alpha/lib_protocol/test/integration/consensus + +or using ``dune exec``:: dune exec src/proto_alpha/lib_protocol/test/integration/consensus/main.exe -And you may further select tests by providing option such as:: +In the latter form you may further select tests by providing options such as:: dune exec src/proto_alpha/lib_protocol/test/integration/consensus/main.exe -- \ --file test_aggregate.ml @@ -41,6 +45,8 @@ To see all the options available, do:: dune exec tezt/tests/main.exe -- --help +See the `Dune documentation `__ for more information on using Dune to run tests. + Running the tests within Docker ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- GitLab From 6c8d2deb2e54f722406923afbd241bf4d2e4f66f Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 12 Nov 2025 14:55:00 +0100 Subject: [PATCH 5/8] doc: link to definition of withdrawal period where needed --- docs/alpha/smart_rollups.rst | 2 ++ docs/introduction/breaking_changes.rst | 2 +- docs/protocols/024_tallinn.rst | 2 +- docs/tallinn/smart_rollups.rst | 3 +++ 4 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/alpha/smart_rollups.rst b/docs/alpha/smart_rollups.rst index 054b14217847..f3f3fa60fe15 100644 --- a/docs/alpha/smart_rollups.rst +++ b/docs/alpha/smart_rollups.rst @@ -252,6 +252,8 @@ There is no need to synchronize between operators: if two honest operators publish the same commitment for a given commitment period, the commitment will be published with two stakes on it. +.. _withdrawal_period_alpha: + A commitment is optimistically trusted but it can be refuted until it is said to be **cemented** (i.e., final, unchangeable). Indeed, right after a commitment is published, a two-week refutation period diff --git a/docs/introduction/breaking_changes.rst b/docs/introduction/breaking_changes.rst index c007874cd692..2db5647d9d45 100644 --- a/docs/introduction/breaking_changes.rst +++ b/docs/introduction/breaking_changes.rst @@ -42,7 +42,7 @@ of affected parameters with their old and new values can be found Unlike other parameters, the value of parameter ``smart_rollup_max_active_outbox_levels`` remains unchanged in terms of blocks. This means that the actual duration of the maximal allowed -period of withdrawal has decreased from ~14 days in protocol Seoul to +:ref:`period of withdrawal ` has decreased from ~14 days in protocol Seoul to ~10 days in protocol Tallinn. Consensus changes diff --git a/docs/protocols/024_tallinn.rst b/docs/protocols/024_tallinn.rst index c494160b0267..52159e177f0d 100644 --- a/docs/protocols/024_tallinn.rst +++ b/docs/protocols/024_tallinn.rst @@ -222,7 +222,7 @@ protocol. For example, the challenge window is still two weeks. Note that the ``smart_rollup_max_active_outbox_levels`` has not been updated, because the current storage implementation of the executed outbox message in the Layer 1 does not allow for a safe update. As a -consequence, the maximal allowed period for withdrawal of assets from +consequence, the maximal allowed :ref:`period for withdrawal ` of assets from smart rollups to Layer 1 has been reduced from ~14 days to ~10 days. diff --git a/docs/tallinn/smart_rollups.rst b/docs/tallinn/smart_rollups.rst index 6c08f4f097ec..157128dea885 100644 --- a/docs/tallinn/smart_rollups.rst +++ b/docs/tallinn/smart_rollups.rst @@ -252,6 +252,9 @@ There is no need to synchronize between operators: if two honest operators publish the same commitment for a given commitment period, the commitment will be published with two stakes on it. +.. _withdrawal_period_t024: +.. _withdrawal_period: + A commitment is optimistically trusted but it can be refuted until it is said to be **cemented** (i.e., final, unchangeable). Indeed, right after a commitment is published, a two-week refutation period -- GitLab From 2f4f67fb8c23da8880eab6a8b0764b6fea4db26d Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 18 Nov 2025 17:03:44 +0100 Subject: [PATCH 6/8] doc: refer to hardware requirements in the Octez overview page --- docs/introduction/tezos.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/introduction/tezos.rst b/docs/introduction/tezos.rst index 269fde4d8f7d..e2d678987112 100644 --- a/docs/introduction/tezos.rst +++ b/docs/introduction/tezos.rst @@ -21,6 +21,7 @@ is available at https://gitlab.com/tezos/tezos. This website contains technical documentation about both Octez and the Tezos protocol. The current latest release of Octez is :doc:`../releases/version-23`. +See that page for minimal hardware requirements for running Octez in a typical setup. A beta version for :doc:`../releases/version-24` is also available. -- GitLab From 16547fbe8dedff86869f055da98fdd5bc18f78e8 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 18 Nov 2025 17:30:04 +0100 Subject: [PATCH 7/8] doc: Present the chatbot on the landing page --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 1609d2904cd2..88311df28600 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,8 @@ Welcome to the Octez and Protocol Documentation! ================================================ This documentation describes an implementation of the `Tezos blockchain `__ consisting of the **Octez toolsuite** and the **Tezos protocol**, for technical users of various kinds, including Tezos application developers, bakers, and Octez/protocol developers. -Enjoy reading this website and consider using the feedback button available in any page (:ref:`more details `). +Enjoy reading this website and consider using the feedback button available in any page (:ref:`more details `) to improve it. +If you have questions about Tezos, consider using the ``Ask AI`` button available on the right side of each page (`more details `__) before reaching out to the :ref:`Tezos community `. .. note:: -- GitLab From 9363f26fa495c6a0c9b4b8821556d8d4c5be8608 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 2 Dec 2025 09:49:59 +0100 Subject: [PATCH 8/8] doc: backport withdrawal period to S and T --- docs/seoul/smart_rollups.rst | 7 +++++-- docs/tallinn/smart_rollups.rst | 7 +++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/seoul/smart_rollups.rst b/docs/seoul/smart_rollups.rst index 7c7c4516f4bf..92c8cc4a271c 100644 --- a/docs/seoul/smart_rollups.rst +++ b/docs/seoul/smart_rollups.rst @@ -254,6 +254,9 @@ There is no need to synchronize between operators: if two honest operators publish the same commitment for a given commitment period, the commitment will be published with two stakes on it. +.. _withdrawal_period_seoul: +.. _withdrawal_period: + A commitment is optimistically trusted but it can be refuted until it is said to be **cemented** (i.e., final, unchangeable). Indeed, right after a commitment is published, a two-week refutation period @@ -263,8 +266,8 @@ concurrent commitment for the same commitment period to force the removal of the invalid commitment. If no one posts such a concurrent commitment during the refutation period, the commitment can be cemented with a dedicated operation injected in Layer 1, and the -outbox messages can be executed by the Layer 1 by an explicit Layer 1 -operation (see :doc:`../shell/smart_rollup_node`), typically +outbox messages can be executed by an explicit Layer 1 +operation (see :ref:`triggering_execution_outbox_message`), typically to transfer assets from the rollup to the Layer 1. Note that such withdrawals are possible during a limited time after cementation, given by the protocol constant ``smart_rollup_max_active_outbox_levels``, which currently corresponds to about two weeks. diff --git a/docs/tallinn/smart_rollups.rst b/docs/tallinn/smart_rollups.rst index 157128dea885..bae64a12b403 100644 --- a/docs/tallinn/smart_rollups.rst +++ b/docs/tallinn/smart_rollups.rst @@ -252,8 +252,7 @@ There is no need to synchronize between operators: if two honest operators publish the same commitment for a given commitment period, the commitment will be published with two stakes on it. -.. _withdrawal_period_t024: -.. _withdrawal_period: +.. _withdrawal_period_tallinn: A commitment is optimistically trusted but it can be refuted until it is said to be **cemented** (i.e., final, unchangeable). Indeed, right @@ -264,8 +263,8 @@ concurrent commitment for the same commitment period to force the removal of the invalid commitment. If no one posts such a concurrent commitment during the refutation period, the commitment can be cemented with a dedicated operation injected in Layer 1, and the -outbox messages can be executed by the Layer 1 by an explicit Layer 1 -operation (see :doc:`../shell/smart_rollup_node`), typically +outbox messages can be executed by an explicit Layer 1 +operation (see :ref:`triggering_execution_outbox_message`), typically to transfer assets from the rollup to the Layer 1. Note that such withdrawals are possible during a limited time after cementation, given by the protocol constant ``smart_rollup_max_active_outbox_levels``, which currently corresponds to about 10 days. -- GitLab