chore(repo): fix monorepo readme links (#18637)

taikoxyz · Dec 24, 2024 · 256e6f4 · 256e6f4
1 parent 3a12014
commit 256e6f4
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 15 deletions.
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/README.md b/README.md
@@ -34,21 +34,27 @@ Get started with Taiko:
 > [!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/software-releases-and-deployments)!
 
-| 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)                                                   |
+| 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/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.
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.