fix: update contract docs

bob-collective · Nov 23, 2023 · cebdda1 · cebdda1
1 parent b1d2e34
commit cebdda1
Show file tree

Hide file tree

Showing 13 changed files with 19 additions and 19 deletions.
diff --git a/docs/docs/contracts/src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md b/docs/docs/contracts/src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md
@@ -1,5 +1,5 @@
 # BitcoinTx
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/BitcoinTx.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/BitcoinTx.sol)
 
 Allows to reference Bitcoin raw transaction in Solidity.
 

diff --git a/docs/docs/contracts/src/src/bridge/BridgeState.sol/library.BridgeState.md b/docs/docs/contracts/src/src/bridge/BridgeState.sol/library.BridgeState.md
@@ -1,5 +1,5 @@
 # BridgeState
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/BridgeState.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/BridgeState.sol)
 
 
 ## Structs

diff --git a/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md b/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md
@@ -1,5 +1,5 @@
 # IRelay
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/IRelay.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/IRelay.sol)
 
 Contains only the methods needed by tBTC v2. The Bitcoin relay
 provides the difficulty of the previous and current epoch. One

diff --git a/docs/docs/contracts/src/src/bridge/WitnessTx.sol/library.WitnessTx.md b/docs/docs/contracts/src/src/bridge/WitnessTx.sol/library.WitnessTx.md
@@ -1,5 +1,5 @@
 # WitnessTx
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/WitnessTx.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/WitnessTx.sol)
 
 
 ## State Variables

diff --git a/docs/docs/contracts/src/src/relay/DummyRelay.sol/contract.DummyRelay.md b/docs/docs/contracts/src/src/relay/DummyRelay.sol/contract.DummyRelay.md
@@ -1,9 +1,9 @@
 # DummyRelay
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/DummyRelay.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/DummyRelay.sol)
 
-[//]: # (**Inherits:**)
+**Inherits:**
 
-[//]: # ([IRelay]&#40;/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md&#41;)
+[IRelay](../../bridge/IRelay.sol/interface.IRelay.md)
 
 *DEV-only!*
 

diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/contract.LightRelay.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/contract.LightRelay.md
@@ -1,9 +1,9 @@
 # LightRelay
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol)
 
-[//]: # (**Inherits:**)
+**Inherits:**
 
-[//]: # (Ownable, [ILightRelay]&#40;/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md&#41;)
+Ownable, [ILightRelay](../../relay/LightRelay.sol/interface.ILightRelay.md)
 
 *THE RELAY MUST NOT BE USED BEFORE GENESIS AND AT LEAST ONE RETARGET.*
 

diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md
@@ -1,9 +1,9 @@
 # ILightRelay
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol)
 
-[//]: # (**Inherits:**)
+**Inherits:**
 
-[//]: # ([IRelay]&#40;/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md&#41;)
+[IRelay](../../bridge/IRelay.sol/interface.IRelay.md)
 
 
 ## Functions

diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/library.RelayUtils.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/library.RelayUtils.md
@@ -1,5 +1,5 @@
 # RelayUtils
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol)
 
 
 ## Functions

diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/struct.Epoch.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/struct.Epoch.md
@@ -1,5 +1,5 @@
 # Epoch
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol)
 
 
 ```solidity

diff --git a/docs/docs/contracts/src/src/swap/Bridge.sol/contract.Bridge.md b/docs/docs/contracts/src/src/swap/Bridge.sol/contract.Bridge.md
@@ -1,5 +1,5 @@
 # Bridge
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Bridge.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Bridge.sol)
 
 
 ## State Variables

diff --git a/docs/docs/contracts/src/src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md b/docs/docs/contracts/src/src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md
@@ -1,5 +1,5 @@
 # BtcMarketPlace
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Btc_Marketplace.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Btc_Marketplace.sol)
 
 
 ## State Variables

diff --git a/docs/docs/contracts/src/src/swap/Marketplace.sol/contract.MarketPlace.md b/docs/docs/contracts/src/src/swap/Marketplace.sol/contract.MarketPlace.md
@@ -1,5 +1,5 @@
 # MarketPlace
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Marketplace.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Marketplace.sol)
 
 
 ## State Variables

diff --git a/docs/docs/contracts/src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md b/docs/docs/contracts/src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md
@@ -1,5 +1,5 @@
 # BobWrappedBtc
-[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Wrapped.sol)
+[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Wrapped.sol)
 
 **Inherits:**
 ERC20, ERC20Burnable, Ownable