add gh-pages docs references to readme.md

idatsy · Jun 17, 2024 · b484046 · b484046
1 parent eebec4f
commit b484046
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,11 @@
 
 ![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)
 ![License](https://img.shields.io/badge/license-UNLICENSED-blue.svg)
+[![Docs](https://img.shields.io/badge/docs-available-blue.svg)](https://idatsy.github.io/eigen-bridge/)
+
+## Developer Documentation
+
+For detailed developer documentation, please visit our [GitHub Pages site](https://idatsy.github.io/eigen-bridge/). This site is autogenerated from the code and provides comprehensive information about the project's structure, functions, and usage.
 
 ## Overview
 

diff --git a/docs/src/README.md b/docs/src/README.md
@@ -1,7 +1,12 @@
-# Eigen-Bridge - Proof of Concept Cross-Chain Bridge Secured by EigenLayer
+# Proof of Concept Cross-Chain Bridge Secured by EigenLayer
 
 ![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)
 ![License](https://img.shields.io/badge/license-UNLICENSED-blue.svg)
+[![Docs](https://img.shields.io/badge/docs-available-blue.svg)](https://idatsy.github.io/eigen-bridge/)
+
+## Developer Documentation
+
+For detailed developer documentation, please visit our [GitHub Pages site](https://idatsy.github.io/eigen-bridge/). This site is autogenerated from the code and provides comprehensive information about the project's structure, functions, and usage.
 
 ## Overview
 
@@ -58,7 +63,7 @@ This proof of concept aims to showcase the potential of EigenLayer in securing d
 
 To run the tests, use the Foundry framework. Running the tests requires an HTTP endpoint to Ethereum mainnet.
 
-> The tests use an anvil fork-test from latest Ethereum mainnet state in order to simulate a realistic environment.
+> The tests use an anvil fork-test from latest Ethereum mainnet state in order to simulate a realistic environment and test against the EigenLayer contracts deployed there.
 
 ```bash
 forge test --rpc-url <RPC_URL>

diff --git a/docs/src/src/ECDSAUtils.sol/contract.ECDSAUtils.md b/docs/src/src/ECDSAUtils.sol/contract.ECDSAUtils.md
@@ -1,5 +1,5 @@
 # ECDSAUtils
-[Git Source](https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/ECDSAUtils.sol)
+[Git Source](https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/ECDSAUtils.sol)
 
 **Inherits:**
 EIP712

diff --git a/docs/src/src/EigenLayerBridge.sol/contract.BridgeServiceManager.md b/docs/src/src/EigenLayerBridge.sol/contract.BridgeServiceManager.md
@@ -1,5 +1,5 @@
 # BridgeServiceManager
-[Git Source](https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/EigenLayerBridge.sol)
+[Git Source](https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/EigenLayerBridge.sol)
 
 **Inherits:**
 ECDSAServiceManagerBase, [Vault](/src/Vault.sol/abstract.Vault.md)

diff --git a/docs/src/src/Events.sol/contract.Events.md b/docs/src/src/Events.sol/contract.Events.md
@@ -1,5 +1,5 @@
 # Events
-[Git Source](https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Events.sol)
+[Git Source](https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Events.sol)
 
 Contains event definitions for bridge operations
 

diff --git a/docs/src/src/PermissionedBridge.sol/contract.PermissionedBridge.md b/docs/src/src/PermissionedBridge.sol/contract.PermissionedBridge.md
@@ -1,5 +1,5 @@
 # PermissionedBridge
-[Git Source](https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/PermissionedBridge.sol)
+[Git Source](https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/PermissionedBridge.sol)
 
 **Inherits:**
 [Vault](/src/Vault.sol/abstract.Vault.md)

diff --git a/docs/src/src/Structs.sol/library.Structs.md b/docs/src/src/Structs.sol/library.Structs.md
@@ -1,5 +1,5 @@
 # Structs
-[Git Source](https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Structs.sol)
+[Git Source](https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Structs.sol)
 
 Contains struct definitions and related functions for bridge operations
 

diff --git a/docs/src/src/Vault.sol/abstract.Vault.md b/docs/src/src/Vault.sol/abstract.Vault.md
@@ -1,5 +1,5 @@
 # Vault
-[Git Source](https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Vault.sol)
+[Git Source](https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Vault.sol)
 
 **Inherits:**
 [ECDSAUtils](/src/ECDSAUtils.sol/contract.ECDSAUtils.md), [Events](/src/Events.sol/contract.Events.md), ReentrancyGuard, OwnableUpgradeable