taikoxyz · davidtaikocha · Dec 24, 2024 · Dec 23, 2024 · Dec 23, 2024 · Dec 23, 2024
diff --git a/.github/workflows/protocol-monitors.yml b/.github/workflows/protocol-monitors.yml
@@ -5,6 +5,7 @@ on:
     types: [opened, synchronize, reopened, ready_for_review]
     paths:
       - "packages/monitors/**"
+      - "!packages/monitors/**/*.md"
     branches-ignore:
       - release-please--branches--**
 

diff --git a/.github/workflows/repo--check-links.yml b/.github/workflows/repo--check-links.yml
@@ -0,0 +1,20 @@
+name: Check links
+
+on:
+  push:
+    paths:
+      - '**/README.md'
+      - docs/**
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Check links
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: --no-progress --verbose '**/README.md'
diff --git a/.github/workflows/taiko-client--test.yml b/.github/workflows/taiko-client--test.yml
@@ -7,6 +7,7 @@ on:
       - "packages/taiko-client/**"
       - "go.mod"
       - "go.sum"
+      - "!**/*.md"
     branches-ignore:
       - release-please--branches--**
 

diff --git a/README.md b/README.md
@@ -32,23 +32,29 @@ Get started with Taiko:
 ## Packages
 
 > [!TIP]
-> Make sure your node is using the latest version tags for taiko-client and taiko-geth. Check out the [node releases page](https://docs.taiko.xyz/network-reference/node-releases)!
-
-| Package                                                                       | Description                                             | Release notes                                                                                                                                                                                                                           |
-| :---------------------------------------------------------------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [bridge-ui](./packages/bridge-ui)                                             | Bridge UI.                                              | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=bridge-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/bridge-ui/CHANGELOG.md)                                             |
-| [docs-site](./packages/docs-site)                                             | End user documentation site.                            | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=docs-site*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/docs-site/CHANGELOG.md)                                             |
-| [eventindexer](./packages/eventindexer)                                       | Event indexer.                                          | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=eventindexer*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/eventindexer/CHANGELOG.md)                                       |
-| [fork-diff](./packages/fork-diff)                                             | Fork diff page.                                         | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=fork-diff*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/fork-diff/CHANGELOG.md)                                             |
-| [guardian-prover-health-check](./packages/guardian-prover-health-check)       | Guardian prover health check service.                   | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=guardian-prover-health-check*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/guardian-prover-health-check/CHANGELOG.md)       |
-| [guardian-prover-health-check-ui](./packages/guardian-prover-health-check-ui) | Guardian prover health check UI.                        | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=guardian-prover-health-check-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/guardian-prover-health-check-ui/CHANGELOG.md) |
-| [protocol](./packages/protocol)                                               | Taiko protocol smart contracts.                         | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=protocol*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/CHANGELOG.md)                                               |
-| [relayer](./packages/relayer)                                                 | Bridge backend relayer.                                 | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=relayer*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/relayer/CHANGELOG.md)                                                 |
-| [snaefell-ui](./packages/snaefell-ui)                                         | Snaefell UI.                                            | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=snaefell-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/snaefell-ui/CHANGELOG.md)                                         |
-| [supplementary-contracts](./packages/supplementary-contracts)                 | Supplementary contracts not part of the Taiko protocol. | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=supplementary-contracts*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/supplementary-contracts/CHANGELOG.md)                 |
-| [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go.                      | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=taiko-client*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/taiko-client/CHANGELOG.md)                                       |
-| [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI.                                             | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=taikoon-ui*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/taikoon-ui/CHANGELOG.md)                                           |
-| [ui-lib](./packages/ui-lib)                                                   | UI library.                                             | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=ui-lib*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/ui-lib/CHANGELOG.md)                                                   |
+> Make sure your node is using the latest version tags for taiko-client and taiko-geth. Check out the [node releases page](https://docs.taiko.xyz/network-reference/software-releases-and-deployments)!
+
+| Package                                                                       | Description                                             |
+| :---------------------------------------------------------------------------- | :------------------------------------------------------ |
+| [balance-monitor](./packages/balance-monitor)                                 | Service that monitors Ethereum L1/L2 addresses and token balances. |
+| [blobstorage](./packages/blobstorage)                                         | Service for storing and retrieving blob data. |
+| [bridge-ui](./packages/bridge-ui)                                             | Bridge UI. |
+| [docs-site](./packages/docs-site)                                             | End user documentation site. |
+| [eventindexer](./packages/eventindexer)                                       | Event indexer. |
+| [fork-diff](./packages/fork-diff)                                             | Fork diff page. |
+| [geth-rpc-gateway](./packages/geth-rpc-gateway)                               | RPC gateway for geth nodes. |
+| [guardian-prover-health-check](./packages/guardian-prover-health-check)       | Guardian prover health check service. |
+| [guardian-prover-health-check-ui](./packages/guardian-prover-health-check-ui) | Guardian prover health check UI. |
+| [monitors](./packages/monitors)                                               | Monitoring and alerting services. |
+| [nfts](./packages/nfts)                                                       | NFT-related smart contracts and utilities. |
+| [protocol](./packages/protocol)                                               | Taiko protocol smart contracts. |
+| [relayer](./packages/relayer)                                                 | Bridge backend relayer. |
+| [snaefell-ui](./packages/snaefell-ui)                                         | Snaefell UI. |
+| [supplementary-contracts](./packages/supplementary-contracts)                 | Supplementary contracts not part of the Taiko protocol. |
+| [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
+| [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
+| [ui-lib](./packages/ui-lib)                                                   | UI library. |
+
 
 ## Issues
 

diff --git a/lychee.toml b/lychee.toml
@@ -0,0 +1 @@
+exclude_path = ["node_modules"]
diff --git a/...cs-site/src/content/docs/network-reference/software-releases-and-deployments.md b/...cs-site/src/content/docs/network-reference/software-releases-and-deployments.md
@@ -1,9 +1,9 @@
 ---
-title: Software releases and Deployments
-description: Network reference page displaying the latest software versions.
+title: Software releases and deployments
+description: Reference page showing the latest Taiko software versions and deployments.
 ---
 
-## Software Releases
+## Software releases
 
 It is **highly recommended** you use the latest software. You can find the latest versions here:
 
@@ -15,12 +15,12 @@ It is **highly recommended** you use the latest software. You can find the lates
 | [simple-taiko-node](https://github.com/taikoxyz/simple-taiko-node/tree/main) | [![Github Release](https://img.shields.io/github/v/release/taikoxyz/simple-taiko-node?label=)](https://github.com/taikoxyz/simple-taiko-node/blob/main/CHANGELOG.md) |
 | [raiko](https://github.com/taikoxyz/raiko/tree/main) | [![Github Release](https://img.shields.io/github/v/release/taikoxyz/raiko?label=)](https://github.com/taikoxyz/raiko/blob/main/CHANGELOG.md) |
 
-## Mainnet Deployment Logs
+## Mainnet deployment logs
 
 You can find the contract addresses of the latest smart contract deployments of the Taiko Protocol on Ethereum [here](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/deployments/mainnet-contract-logs-L1.md).
 
 You can find the smart contract addresses of L2 contracts for the Taiko Protocol on Mainnet [here](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/deployments/mainnet-contract-logs-L2.md).
 
-## Hekla Deployment Logs
+## Hekla deployment logs
 
 You can find the all L1 and L2 contract addresses of the latest smart contract deployments of the Taiko Protocol [here](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/deployments/hekla-contract-logs.md).
diff --git a/packages/monitors/README.md b/packages/monitors/README.md
@@ -0,0 +1,3 @@
+# Monitors
+
+This package contains monitoring and alerting services for the Taiko protocol. It uses OpenZeppelin Defender for monitoring smart contracts and setting up automated alerts.
diff --git a/packages/taiko-client/README.md b/packages/taiko-client/README.md
@@ -5,7 +5,7 @@
 <!-- TODO(d1onys1us): fix codecov integration -->
 <!-- [![Codecov](https://img.shields.io/codecov/c/github/taikoxyz/taiko-mono/packages/taiko-client?logo=codecov&token=OH6BJMVP6O)](https://codecov.io/gh/taikoxyz/taiko-mono/packages/taiko-client) -->
 
-Taiko protocol's client software implementation in Go. Learn more about Taiko nodes with [the docs](https://docs.taiko.xyz/core-concepts/taiko-nodes/).
+Taiko protocol's client software implementation in Go. Learn more about Taiko nodes with [the docs](https://docs.taiko.xyz/taiko-protocol/taiko-nodes).
 
 ## Project structure
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Monitors

		This package contains monitoring and alerting services for the Taiko protocol. It uses OpenZeppelin Defender for monitoring smart contracts and setting up automated alerts.