chore: add warning in example modules

defi-wonderland · Nov 13, 2024 · 84afca8 · 84afca8
1 parent 13e0ba1
commit 84afca8
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 0 deletions.
diff --git a/docs/src/content/modules/dispute/bonded_dispute_module.md b/docs/src/content/modules/dispute/bonded_dispute_module.md
@@ -1,5 +1,8 @@
 # Bonded Dispute Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [IBondedDisputeModule.sol](/solidity/interfaces/modules/dispute/IBondedDisputeModule.sol/interface.IBondedDisputeModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/dispute/circuit_resolver_module.md b/docs/src/content/modules/dispute/circuit_resolver_module.md
@@ -1,5 +1,8 @@
 # Circuit Resolver Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [ICircuitResolverModule.sol](/solidity/interfaces/modules/dispute/ICircuitResolverModule.sol/interface.ICircuitResolverModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/dispute/root_verification_module.md b/docs/src/content/modules/dispute/root_verification_module.md
@@ -1,5 +1,8 @@
 # Root Verification Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [IRootVerificationModule.sol](/solidity/interfaces/modules/dispute/IRootVerificationModule.sol/interface.IRootVerificationModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/finality/multiple_callbacks_module.md b/docs/src/content/modules/finality/multiple_callbacks_module.md
@@ -1,5 +1,8 @@
 # Multiple Callbacks Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [IMultipleCallbacksModule.sol](/solidity/interfaces/modules/finality/IMultipleCallbacksModule.sol/interface.IMultipleCallbacksModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/request/contract_call_request_module.md b/docs/src/content/modules/request/contract_call_request_module.md
@@ -1,5 +1,8 @@
 # Contract Call Request Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [IContractCallRequestModule.sol](/solidity/interfaces/modules/request/IContractCallRequestModule.sol/interface.IContractCallRequestModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/request/sparse_merkle_tree_request_module.md b/docs/src/content/modules/request/sparse_merkle_tree_request_module.md
@@ -1,5 +1,8 @@
 # Sparse Merkle Tree Request Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [ISparseMerkleTreeRequestModule.sol](/solidity/interfaces/modules/request/ISparseMerkleTreeRequestModule.sol/interface.ISparseMerkleTreeRequestModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/resolution/bond_escalation_resolution_module.md b/docs/src/content/modules/resolution/bond_escalation_resolution_module.md
@@ -1,5 +1,8 @@
 # Bond Escalation Resolution Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [IBondEscalationResolutionModule.sol](/solidity/interfaces/modules/resolution/IBondEscalationResolutionModule.sol/interface.IBondEscalationResolutionModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/resolution/erc20_resolution_module.md b/docs/src/content/modules/resolution/erc20_resolution_module.md
@@ -1,5 +1,8 @@
 # ERC20 Resolution Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [IERC20ResolutionModule.sol](/solidity/interfaces/modules/resolution/IERC20ResolutionModule.sol/interface.IERC20ResolutionModule.md) for more details.
 
 ## 1. Introduction

diff --git a/docs/src/content/modules/resolution/private_erc20_resolution_module.md b/docs/src/content/modules/resolution/private_erc20_resolution_module.md
@@ -1,5 +1,8 @@
 # Private ERC20 Resolution Module
 
+> [!CAUTION]
+> The contracts included in the examples folder have not been thoroughly tested nor audited and are meant to be examples or source of inspiration for new modules. Do not use them in a production environment.
+
 See [IPrivateERC20ResolutionModule.sol](/solidity/interfaces/modules/resolution/IPrivateERC20ResolutionModule.sol/interface.IPrivateERC20ResolutionModule.md) for more details.
 
 ## 1. Introduction