update contract docs

firstbatchxyz · Dec 18, 2024 · 72eb2ff · 72eb2ff
1 parent 4083e0e
commit 72eb2ff
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -200,16 +200,13 @@ You can see the snapshot `.gas-snapshot` file in the current directory.
 
 ## Documentation
 
-We have auto-generated documentation under the [`docs`](./docs) folder, generated with the following command:
+We have auto-generated MDBook documentations under the [`docs`](./docs) folder, generated with the following command:
 
 ```sh
 forge doc
-```
-
-We provide an MDBook template over it, which you can open via:
 
-```sh
-cd docs && mdbook serve --open
+# servers the book as well
+forge doc --serve
 ```
 
 ## License

diff --git a/docs/src/README.md b/docs/src/README.md
@@ -200,16 +200,13 @@ You can see the snapshot `.gas-snapshot` file in the current directory.
 
 ## Documentation
 
-We have auto-generated documentation under the [`docs`](./docs) folder, generated with the following command:
+We have auto-generated MDBook documentations under the [`docs`](./docs) folder, generated with the following command:
 
 ```sh
 forge doc
-```
-
-We provide an MDBook template over it, which you can open via:
 
-```sh
-cd docs && mdbook serve --open
+# servers the book as well
+forge doc --serve
 ```
 
 ## License

diff --git a/docs/src/src/LLMOracleCoordinator.sol/contract.LLMOracleCoordinator.md b/docs/src/src/LLMOracleCoordinator.sol/contract.LLMOracleCoordinator.md
@@ -1,5 +1,5 @@
 # LLMOracleCoordinator
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/LLMOracleCoordinator.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/LLMOracleCoordinator.sol)
 
 **Inherits:**
 [LLMOracleTask](/src/LLMOracleTask.sol/interface.LLMOracleTask.md), [LLMOracleManager](/src/LLMOracleManager.sol/abstract.LLMOracleManager.md), UUPSUpgradeable

diff --git a/docs/src/src/LLMOracleManager.sol/abstract.LLMOracleManager.md b/docs/src/src/LLMOracleManager.sol/abstract.LLMOracleManager.md
@@ -1,5 +1,5 @@
 # LLMOracleManager
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/LLMOracleManager.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/LLMOracleManager.sol)
 
 **Inherits:**
 OwnableUpgradeable

diff --git a/docs/src/src/LLMOracleRegistry.sol/contract.LLMOracleRegistry.md b/docs/src/src/LLMOracleRegistry.sol/contract.LLMOracleRegistry.md
@@ -1,5 +1,5 @@
 # LLMOracleRegistry
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/LLMOracleRegistry.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/LLMOracleRegistry.sol)
 
 **Inherits:**
 [Whitelist](/src/Whitelist.sol/abstract.Whitelist.md), UUPSUpgradeable

diff --git a/docs/src/src/LLMOracleRegistry.sol/enum.LLMOracleKind.md b/docs/src/src/LLMOracleRegistry.sol/enum.LLMOracleKind.md
@@ -1,5 +1,5 @@
 # LLMOracleKind
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/LLMOracleRegistry.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/LLMOracleRegistry.sol)
 
 The type of Oracle.
 

diff --git a/docs/src/src/LLMOracleTask.sol/interface.LLMOracleTask.md b/docs/src/src/LLMOracleTask.sol/interface.LLMOracleTask.md
@@ -1,5 +1,5 @@
 # LLMOracleTask
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/LLMOracleTask.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/LLMOracleTask.sol)
 
 An umbrella interface that captures task-related structs and enums.
 

diff --git a/docs/src/src/LLMOracleTask.sol/struct.LLMOracleTaskParameters.md b/docs/src/src/LLMOracleTask.sol/struct.LLMOracleTaskParameters.md
@@ -1,5 +1,5 @@
 # LLMOracleTaskParameters
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/LLMOracleTask.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/LLMOracleTask.sol)
 
 Collection of oracle task-related parameters.
 

diff --git a/docs/src/src/Statistics.sol/library.Statistics.md b/docs/src/src/Statistics.sol/library.Statistics.md
@@ -1,5 +1,5 @@
 # Statistics
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/Statistics.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/Statistics.sol)
 
 Simple statistic library for uint256 arrays.
 

diff --git a/docs/src/src/Whitelist.sol/abstract.Whitelist.md b/docs/src/src/Whitelist.sol/abstract.Whitelist.md
@@ -1,5 +1,5 @@
 # Whitelist
-[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/a0589a694000a1a1e8d0cf54f0527c1c8a33c301/src/Whitelist.sol)
+[Git Source](https://github.com/firstbatchxyz/dria-oracle-contracts/blob/4083e0e4f3f5849460fbea5040ecc77651509d1c/src/Whitelist.sol)
 
 **Inherits:**
 OwnableUpgradeable

diff --git a/foundry.toml b/foundry.toml
@@ -4,7 +4,7 @@ out = "out"
 libs = ["lib"]
 test = 'test'
 script = 'script'
-cache_path  = 'cache'
+cache_path = 'cache'
 
 ffi = true
 ast = true
@@ -15,6 +15,6 @@ extra_output = ["storageLayout"]
 # fs permissions for deployment (false by default)
 fs_permissions = [
     { access = "read", path = "out" },
-    { access = "read-write", path = "deployment" }
+    { access = "read-write", path = "deployment" },
 ]
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options