fix: update location of example modules' interfaces

defi-wonderland · Nov 26, 2024 · 8fc5fd6 · 8fc5fd6
1 parent 8c9c210
commit 8fc5fd6
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 23 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -55,7 +55,13 @@
 
 - [Interfaces]()
     - [❱ core](solidity/interfaces/core/README.md)
+      - [❱ access](solidity/interfaces/core/access/README.md)
+        - [IAccessController](solidity/interfaces/core/access/IAccessController.sol/interface.IAccessController.md)
+        - [IModuleAccessController](solidity/interfaces/core/access/IModuleAccessController.sol/interface.IModuleAccessController.md)
+        - [IOracleAccessController](solidity/interfaces/core/access/IOracleAccessController.sol/interface.IOracleAccessController.md)
       - [❱ modules](solidity/interfaces/core/modules/README.md)
+        - [❱ access](solidity/interfaces/core/modules/access/README.md)
+          - [IAccessModule](solidity/interfaces/core/modules/access/IAccessModule.sol/interface.IAccessModule.md)
         - [❱ dispute](solidity/interfaces/core/modules/dispute/README.md)
           - [IDisputeModule](solidity/interfaces/core/modules/dispute/IDisputeModule.sol/interface.IDisputeModule.md)
         - [❱ finality](solidity/interfaces/core/modules/finality/README.md)
@@ -68,28 +74,35 @@
           - [IResponseModule](solidity/interfaces/core/modules/response/IResponseModule.sol/interface.IResponseModule.md)
       - [IModule](solidity/interfaces/core/IModule.sol/interface.IModule.md)
       - [IOracle](solidity/interfaces/core/IOracle.sol/interface.IOracle.md)
+      - [IValidator](solidity/interfaces/core/IValidator.sol/interface.IValidator.md)
+    - [❱ examples](solidity/interfaces/examples/README.md)
+      - [❱ modules](solidity/interfaces/examples/modules/README.md)
+        - [❱ dispute](solidity/interfaces/examples/modules/dispute/README.md)
+          - [IBondedDisputeModule](solidity/interfaces/examples/modules/dispute/IBondedDisputeModule.sol/interface.IBondedDisputeModule.md)
+          - [ICircuitResolverModule](solidity/interfaces/examples/modules/dispute/ICircuitResolverModule.sol/interface.ICircuitResolverModule.md)
+          - [IRootVerificationModule](solidity/interfaces/examples/modules/dispute/IRootVerificationModule.sol/interface.IRootVerificationModule.md)
+        - [❱ finality](solidity/interfaces/examples/modules/finality/README.md)
+          - [ICallbackModule](solidity/interfaces/examples/modules/finality/ICallbackModule.sol/interface.ICallbackModule.md)
+          - [IMultipleCallbacksModule](solidity/interfaces/examples/modules/finality/IMultipleCallbacksModule.sol/interface.IMultipleCallbacksModule.md)
+        - [❱ request](solidity/interfaces/examples/modules/request/README.md)
+          - [IContractCallRequestModule](solidity/interfaces/examples/modules/request/IContractCallRequestModule.sol/interface.IContractCallRequestModule.md)
+          - [IHttpRequestModule](solidity/interfaces/examples/modules/request/IHttpRequestModule.sol/interface.IHttpRequestModule.md)
+          - [ISparseMerkleTreeRequestModule](solidity/interfaces/examples/modules/request/ISparseMerkleTreeRequestModule.sol/interface.ISparseMerkleTreeRequestModule.md)
+        - [❱ resolution](solidity/interfaces/examples/modules/resolution/README.md)
+          - [IBondEscalationResolutionModule](solidity/interfaces/examples/modules/resolution/IBondEscalationResolutionModule.sol/interface.IBondEscalationResolutionModule.md)
+          - [IERC20ResolutionModule](solidity/interfaces/examples/modules/resolution/IERC20ResolutionModule.sol/interface.IERC20ResolutionModule.md)
+          - [IPrivateERC20ResolutionModule](solidity/interfaces/examples/modules/resolution/IPrivateERC20ResolutionModule.sol/interface.IPrivateERC20ResolutionModule.md)
     - [❱ extensions](solidity/interfaces/extensions/README.md)
       - [IAccountingExtension](solidity/interfaces/extensions/IAccountingExtension.sol/interface.IAccountingExtension.md)
       - [IBondEscalationAccounting](solidity/interfaces/extensions/IBondEscalationAccounting.sol/interface.IBondEscalationAccounting.md)
     - [❱ modules](solidity/interfaces/modules/README.md)
       - [❱ dispute](solidity/interfaces/modules/dispute/README.md)
         - [IBondEscalationModule](solidity/interfaces/modules/dispute/IBondEscalationModule.sol/interface.IBondEscalationModule.md)
-        - [IBondedDisputeModule](solidity/interfaces/modules/dispute/IBondedDisputeModule.sol/interface.IBondedDisputeModule.md)
-        - [ICircuitResolverModule](solidity/interfaces/modules/dispute/ICircuitResolverModule.sol/interface.ICircuitResolverModule.md)
-        - [IRootVerificationModule](solidity/interfaces/modules/dispute/IRootVerificationModule.sol/interface.IRootVerificationModule.md)
-      - [❱ finality](solidity/interfaces/modules/finality/README.md)
-        - [ICallbackModule](solidity/interfaces/modules/finality/ICallbackModule.sol/interface.ICallbackModule.md)
-        - [IMultipleCallbacksModule](solidity/interfaces/modules/finality/IMultipleCallbacksModule.sol/interface.IMultipleCallbacksModule.md)
-      - [❱ request](solidity/interfaces/modules/request/README.md)
-        - [IContractCallRequestModule](solidity/interfaces/modules/request/IContractCallRequestModule.sol/interface.IContractCallRequestModule.md)
-        - [IHttpRequestModule](solidity/interfaces/modules/request/IHttpRequestModule.sol/interface.IHttpRequestModule.md)
-        - [ISparseMerkleTreeRequestModule](solidity/interfaces/modules/request/ISparseMerkleTreeRequestModule.sol/interface.ISparseMerkleTreeRequestModule.md)
       - [❱ resolution](solidity/interfaces/modules/resolution/README.md)
         - [IArbitratorModule](solidity/interfaces/modules/resolution/IArbitratorModule.sol/interface.IArbitratorModule.md)
-        - [IBondEscalationResolutionModule](solidity/interfaces/modules/resolution/IBondEscalationResolutionModule.sol/interface.IBondEscalationResolutionModule.md)
-        - [IERC20ResolutionModule](solidity/interfaces/modules/resolution/IERC20ResolutionModule.sol/interface.IERC20ResolutionModule.md)
-        - [IPrivateERC20ResolutionModule](solidity/interfaces/modules/resolution/IPrivateERC20ResolutionModule.sol/interface.IPrivateERC20ResolutionModule.md)
       - [❱ response](solidity/interfaces/modules/response/README.md)
         - [IBondedResponseModule](solidity/interfaces/modules/response/IBondedResponseModule.sol/interface.IBondedResponseModule.md)
     - [IArbitrator](solidity/interfaces/IArbitrator.sol/interface.IArbitrator.md)
+    - [IProphetCallback](solidity/interfaces/IProphetCallback.sol/interface.IProphetCallback.md)
+    - [IProphetVerifier](solidity/interfaces/IProphetVerifier.sol/interface.IProphetVerifier.md)
     - [ITreeVerifier](solidity/interfaces/ITreeVerifier.sol/interface.ITreeVerifier.md)
diff --git a/docs/src/content/modules/dispute/bonded_dispute_module.md b/docs/src/content/modules/dispute/bonded_dispute_module.md
@@ -3,7 +3,7 @@
 > [!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.
+See [IBondedDisputeModule.sol](/solidity/interfaces/examples/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
@@ -3,7 +3,7 @@
 > [!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.
+See [ICircuitResolverModule.sol](/solidity/interfaces/examples/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
@@ -3,7 +3,7 @@
 > [!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.
+See [IRootVerificationModule.sol](/solidity/interfaces/examples/modules/dispute/IRootVerificationModule.sol/interface.IRootVerificationModule.md) for more details.
 
 ## 1. Introduction
 

diff --git a/docs/src/content/modules/finality/callback_module.md b/docs/src/content/modules/finality/callback_module.md
@@ -1,6 +1,6 @@
 # Callback Module
 
-See [ICallbackModule.sol](/solidity/interfaces/modules/finality/ICallbackModule.sol/interface.ICallbackModule.md) for more details.
+See [ICallbackModule.sol](/solidity/interfaces/examples/modules/finality/ICallbackModule.sol/interface.ICallbackModule.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
@@ -3,7 +3,7 @@
 > [!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.
+See [IMultipleCallbacksModule.sol](/solidity/interfaces/examples/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
@@ -3,7 +3,7 @@
 > [!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.
+See [IContractCallRequestModule.sol](/solidity/interfaces/examples/modules/request/IContractCallRequestModule.sol/interface.IContractCallRequestModule.md) for more details.
 
 ## 1. Introduction
 

diff --git a/docs/src/content/modules/request/http_request_module.md b/docs/src/content/modules/request/http_request_module.md
@@ -1,6 +1,6 @@
 # HTTP Request Module
 
-See [IHttpRequestModule.sol](/solidity/interfaces/modules/request/IHttpRequestModule.sol/interface.IHttpRequestModule.md) for more details.
+See [IHttpRequestModule.sol](/solidity/interfaces/examples/modules/request/IHttpRequestModule.sol/interface.IHttpRequestModule.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
@@ -3,7 +3,7 @@
 > [!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.
+See [ISparseMerkleTreeRequestModule.sol](/solidity/interfaces/examples/modules/request/ISparseMerkleTreeRequestModule.sol/interface.ISparseMerkleTreeRequestModule.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
@@ -3,7 +3,7 @@
 > [!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.
+See [IERC20ResolutionModule.sol](/solidity/interfaces/examples/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
@@ -3,7 +3,7 @@
 > [!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.
+See [IPrivateERC20ResolutionModule.sol](/solidity/interfaces/examples/modules/resolution/IPrivateERC20ResolutionModule.sol/interface.IPrivateERC20ResolutionModule.md) for more details.
 
 ## 1. Introduction