From 46e453405cf6ea5bacc94c39d7a2967603d88806 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 11:36:55 -0500
Subject: [PATCH 01/27] chore(repo): fix monorepo readme links

---
 README.md                   | 35 ++++++++++++++++++++---------------
 packages/monitors/README.md |  3 +++
 2 files changed, 23 insertions(+), 15 deletions(-)
 create mode 100644 packages/monitors/README.md

diff --git a/README.md b/README.md
index 14af724cf8c..84a08271ab7 100644
--- a/README.md
+++ b/README.md
@@ -34,21 +34,26 @@ 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
new file mode 100644
index 00000000000..43f6628df45
--- /dev/null
+++ 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.

From 2a298f00279e710f06f62ae4d643119cd8074688 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:06:00 -0500
Subject: [PATCH 02/27] add workflow

---
 .../workflows/repo--validate-package-docs.yml | 58 +++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 .github/workflows/repo--validate-package-docs.yml

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
new file mode 100644
index 00000000000..d6a54c7e69b
--- /dev/null
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -0,0 +1,58 @@
+name: Validate Package Docs
+
+on:
+  pull_request:
+    paths:
+      - '**/README.md'
+      - 'packages/*/'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    env:
+      EXPECTED_PACKAGE_COUNT: 18  # Update this when packages are added/removed
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Validate packages
+        run: |
+          # Get current package count
+          CURRENT_COUNT=$(ls -d packages/*/ | wc -l | tr -d ' ')
+          if [ "$CURRENT_COUNT" != "$EXPECTED_PACKAGE_COUNT" ]; then
+            echo "❌ Package count mismatch! Expected $EXPECTED_PACKAGE_COUNT but found $CURRENT_COUNT"
+            echo "Update EXPECTED_PACKAGE_COUNT in workflow if this was intentional"
+            exit 1
+          fi
+
+          # Get package lists
+          PACKAGES=$(ls -d packages/*/ | cut -f2 -d'/' | sort)
+          README_PACKAGES=$(grep -o '\[.*\]([^)]*/packages/[^)]*)' README.md | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort)
+
+          if [ -z "$README_PACKAGES" ]; then
+            echo "❌ No package links found in README.md. Table might be malformed."
+            exit 1
+          fi
+
+          # Check for mismatches
+          MISSING_IN_README=$(comm -23 <(echo "$PACKAGES") <(echo "$README_PACKAGES"))
+          EXTRA_IN_README=$(comm -13 <(echo "$PACKAGES") <(echo "$README_PACKAGES"))
+
+          if [ ! -z "$MISSING_IN_README" ]; then
+            echo "❌ Packages not documented in README.md: $MISSING_IN_README"
+            exit 1
+          fi
+
+          if [ ! -z "$EXTRA_IN_README" ]; then
+            echo "❌ Non-existent packages in README.md: $EXTRA_IN_README"
+            exit 1
+          fi
+
+          # Check for missing READMEs
+          for pkg in packages/*/; do
+            if [ ! -f "${pkg}README.md" ]; then
+              echo "❌ Missing README.md in ${pkg}"
+              exit 1
+            fi
+          done
+
+          echo "✅ All package documentation is valid"

From 1376eccafeaa08842d7ebdb4b27b55637b512229 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:20:26 -0500
Subject: [PATCH 03/27] update

---
 .github/workflows/protocol-monitors.yml           | 1 +
 .github/workflows/repo--validate-package-docs.yml | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/protocol-monitors.yml b/.github/workflows/protocol-monitors.yml
index ad640962afe..00c96440f94 100644
--- 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--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index d6a54c7e69b..feb7f8c28ec 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -24,12 +24,12 @@ jobs:
             exit 1
           fi
 
-          # Get package lists
+          # Extract packages section and find table entries (after the header row and separator)
           PACKAGES=$(ls -d packages/*/ | cut -f2 -d'/' | sort)
-          README_PACKAGES=$(grep -o '\[.*\]([^)]*/packages/[^)]*)' README.md | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort)
+          README_PACKAGES=$(awk '/^## Packages$/,/^##/ {print}' README.md | awk '/^\| Package.*\| Description/ {p=1;next} /^\| :?-+/ {next} p==1 && /^\|/ {print}' | grep -o '\[.*\]([^)]*/packages/[^)]*)' | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
 
           if [ -z "$README_PACKAGES" ]; then
-            echo "❌ No package links found in README.md. Table might be malformed."
+            echo "❌ No package entries found in README.md table. Table might be malformed."
             exit 1
           fi
 

From 3efeed712a475487f31b20564947d86815053377 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:30:55 -0500
Subject: [PATCH 04/27] update

---
 .github/workflows/repo--validate-package-docs.yml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index feb7f8c28ec..38f7a19a345 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -1,3 +1,4 @@
+---
 name: Validate Package Docs
 
 on:
@@ -24,9 +25,9 @@ jobs:
             exit 1
           fi
 
-          # Extract packages section and find table entries (after the header row and separator)
+          # Extract packages section and find table entries
           PACKAGES=$(ls -d packages/*/ | cut -f2 -d'/' | sort)
-          README_PACKAGES=$(awk '/^## Packages$/,/^##/ {print}' README.md | awk '/^\| Package.*\| Description/ {p=1;next} /^\| :?-+/ {next} p==1 && /^\|/ {print}' | grep -o '\[.*\]([^)]*/packages/[^)]*)' | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
+          README_PACKAGES=$(sed -n '/^## Packages$/,/^## /p' README.md | tr -d '\n' | grep -o '|\s*\[.*\]([^)]*/packages/[^)]*)'  | grep -o '/packages/[^)]*' | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
 
           if [ -z "$README_PACKAGES" ]; then
             echo "❌ No package entries found in README.md table. Table might be malformed."

From f2392b4cd1c980de3872945e5ce3f187624fee54 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:34:07 -0500
Subject: [PATCH 05/27] test: missing package

---
 README.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/README.md b/README.md
index 84a08271ab7..7797d3e434d 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,6 @@ Get started with Taiko:
 | [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
 

From 117e25049bd49a8aa2cbc6f3970ea7856a8fdd89 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:35:15 -0500
Subject: [PATCH 06/27] test: deprecated package

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 7797d3e434d..cf50ed867e2 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,8 @@ Get started with Taiko:
 | [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. |
+| [deprecated-package](./packages/ui-lib)                                       | UI library. |
 
 ## Issues
 

From 5b25ca2c2342c749b63cd01ddf142ebfc4f33004 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:36:05 -0500
Subject: [PATCH 07/27] test: deprecated package broken link

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cf50ed867e2..5775694c94b 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
-| [deprecated-package](./packages/ui-lib)                                       | UI library. |
+| [deprecated-package](./packages/fail)                                       | UI library. |
 
 ## Issues
 

From ae5fb7718697173c59858aa69e41f90a692f26d8 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:37:03 -0500
Subject: [PATCH 08/27] test: new package not added to readme

---
 README.md                      | 1 -
 packages/new-package/kitty.txt | 1 +
 2 files changed, 1 insertion(+), 1 deletion(-)
 create mode 100644 packages/new-package/kitty.txt

diff --git a/README.md b/README.md
index 5775694c94b..84a08271ab7 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,6 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
-| [deprecated-package](./packages/fail)                                       | UI library. |
 
 ## Issues
 
diff --git a/packages/new-package/kitty.txt b/packages/new-package/kitty.txt
new file mode 100644
index 00000000000..45b983be36b
--- /dev/null
+++ b/packages/new-package/kitty.txt
@@ -0,0 +1 @@
+hi

From 7573a874d81794b9d5f055616a1e1004455e5621 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:38:29 -0500
Subject: [PATCH 09/27] test: update package count but no readme still

---
 .github/workflows/repo--validate-package-docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index 38f7a19a345..7f145a26301 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -11,7 +11,7 @@ jobs:
   validate:
     runs-on: ubuntu-latest
     env:
-      EXPECTED_PACKAGE_COUNT: 18  # Update this when packages are added/removed
+      EXPECTED_PACKAGE_COUNT: 19  # Update this when packages are added/removed
     steps:
       - uses: actions/checkout@v4
 

From 0534cff181908ee1e437cb8b33738509a514e871 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:41:33 -0500
Subject: [PATCH 10/27] test: document new package but no readme

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 84a08271ab7..f08536e91a5 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,7 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
+| [new-package](./packages/new-package)                                         | new package |
 
 ## Issues
 

From c13b62c3937f0bb9c57df4d36dbcdb1651521351 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:42:14 -0500
Subject: [PATCH 11/27] test: add readme (should pass now)

---
 packages/new-package/README.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 packages/new-package/README.md

diff --git a/packages/new-package/README.md b/packages/new-package/README.md
new file mode 100644
index 00000000000..45b983be36b
--- /dev/null
+++ b/packages/new-package/README.md
@@ -0,0 +1 @@
+hi

From 4080766b4addc907db3731495724c51021270744 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:43:08 -0500
Subject: [PATCH 12/27] test: remove a package

---
 packages/new-package/README.md | 1 -
 packages/new-package/kitty.txt | 1 -
 2 files changed, 2 deletions(-)
 delete mode 100644 packages/new-package/README.md
 delete mode 100644 packages/new-package/kitty.txt

diff --git a/packages/new-package/README.md b/packages/new-package/README.md
deleted file mode 100644
index 45b983be36b..00000000000
--- a/packages/new-package/README.md
+++ /dev/null
@@ -1 +0,0 @@
-hi
diff --git a/packages/new-package/kitty.txt b/packages/new-package/kitty.txt
deleted file mode 100644
index 45b983be36b..00000000000
--- a/packages/new-package/kitty.txt
+++ /dev/null
@@ -1 +0,0 @@
-hi

From 0f1c0b58eec995f4ddb15ae051189ce2a464df61 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:43:44 -0500
Subject: [PATCH 13/27] test: make happy by updating readme

---
 README.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/README.md b/README.md
index f08536e91a5..84a08271ab7 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,6 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
-| [new-package](./packages/new-package)                                         | new package |
 
 ## Issues
 

From 97a579015ca25e4586589f0f2506cfda26d6cab8 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:44:26 -0500
Subject: [PATCH 14/27] test: make happy by updating readme

---
 .github/workflows/repo--validate-package-docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index 7f145a26301..38f7a19a345 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -11,7 +11,7 @@ jobs:
   validate:
     runs-on: ubuntu-latest
     env:
-      EXPECTED_PACKAGE_COUNT: 19  # Update this when packages are added/removed
+      EXPECTED_PACKAGE_COUNT: 18  # Update this when packages are added/removed
     steps:
       - uses: actions/checkout@v4
 

From 81844d4ad59146eb80e639daca0ba894fe872759 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:45:09 -0500
Subject: [PATCH 15/27] test: another

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 84a08271ab7..b7de32a8c68 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,8 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
+| [duplicate](./packages/wrongpathidk)                                                   | UI library. |
+
 
 ## Issues
 

From dccf7c6f83bb2015329e84e3f1bbdeb203df33bf Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:45:45 -0500
Subject: [PATCH 16/27] test: another

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b7de32a8c68..3a4c2830de1 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
-| [duplicate](./packages/wrongpathidk)                                                   | UI library. |
+| [duplicatewrongname](./packages/ui-lib)                                                   | UI library. |
 
 
 ## Issues

From fb2261b1128da446e5f8d5ce3914e6e7f7e44b6e Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:50:58 -0500
Subject: [PATCH 17/27] test: now should fail

---
 .../workflows/repo--validate-package-docs.yml | 23 ++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index 38f7a19a345..eab990f83c5 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -27,7 +27,28 @@ jobs:
 
           # Extract packages section and find table entries
           PACKAGES=$(ls -d packages/*/ | cut -f2 -d'/' | sort)
-          README_PACKAGES=$(sed -n '/^## Packages$/,/^## /p' README.md | tr -d '\n' | grep -o '|\s*\[.*\]([^)]*/packages/[^)]*)'  | grep -o '/packages/[^)]*' | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
+
+          # Get all package paths from README and check for duplicates
+          PACKAGE_PATHS=$(sed -n '/^## Packages$/,/^## /p' README.md | tr -d '\n' | grep -o '|\s*\[.*\]([^)]*/packages/[^)]*)'  | grep -o '/packages/[^)]*')
+
+          # Count table rows (excluding header and separator)
+          TABLE_ROW_COUNT=$(echo "$PACKAGE_PATHS" | wc -l | tr -d ' ')
+          if [ "$TABLE_ROW_COUNT" != "$EXPECTED_PACKAGE_COUNT" ]; then
+            echo "❌ Table row count mismatch! Expected $EXPECTED_PACKAGE_COUNT rows but found $TABLE_ROW_COUNT"
+            echo "Make sure there are no extra or missing rows in the packages table"
+            exit 1
+          fi
+
+          # Check for duplicate paths
+          DUPLICATE_PATHS=$(echo "$PACKAGE_PATHS" | sort | uniq -d)
+          if [ ! -z "$DUPLICATE_PATHS" ]; then
+            echo "❌ Found duplicate package paths in README.md:"
+            echo "$DUPLICATE_PATHS"
+            exit 1
+          fi
+
+          # Extract unique package names for comparison
+          README_PACKAGES=$(echo "$PACKAGE_PATHS" | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
 
           if [ -z "$README_PACKAGES" ]; then
             echo "❌ No package entries found in README.md table. Table might be malformed."

From f85ff4ff1dc8e732f7e2fcc7df41243e53604f26 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:52:47 -0500
Subject: [PATCH 18/27] test: now should fail

---
 .../workflows/repo--validate-package-docs.yml    | 16 ++--------------
 1 file changed, 2 insertions(+), 14 deletions(-)

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index eab990f83c5..5fec9abfec0 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -27,11 +27,10 @@ jobs:
 
           # Extract packages section and find table entries
           PACKAGES=$(ls -d packages/*/ | cut -f2 -d'/' | sort)
-
-          # Get all package paths from README and check for duplicates
           PACKAGE_PATHS=$(sed -n '/^## Packages$/,/^## /p' README.md | tr -d '\n' | grep -o '|\s*\[.*\]([^)]*/packages/[^)]*)'  | grep -o '/packages/[^)]*')
+          README_PACKAGES=$(echo "$PACKAGE_PATHS" | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
 
-          # Count table rows (excluding header and separator)
+          # Check table row count matches expected
           TABLE_ROW_COUNT=$(echo "$PACKAGE_PATHS" | wc -l | tr -d ' ')
           if [ "$TABLE_ROW_COUNT" != "$EXPECTED_PACKAGE_COUNT" ]; then
             echo "❌ Table row count mismatch! Expected $EXPECTED_PACKAGE_COUNT rows but found $TABLE_ROW_COUNT"
@@ -39,17 +38,6 @@ jobs:
             exit 1
           fi
 
-          # Check for duplicate paths
-          DUPLICATE_PATHS=$(echo "$PACKAGE_PATHS" | sort | uniq -d)
-          if [ ! -z "$DUPLICATE_PATHS" ]; then
-            echo "❌ Found duplicate package paths in README.md:"
-            echo "$DUPLICATE_PATHS"
-            exit 1
-          fi
-
-          # Extract unique package names for comparison
-          README_PACKAGES=$(echo "$PACKAGE_PATHS" | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
-
           if [ -z "$README_PACKAGES" ]; then
             echo "❌ No package entries found in README.md table. Table might be malformed."
             exit 1

From 72ce58b917d406686680ce5da08dfa71a9e1de74 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:54:29 -0500
Subject: [PATCH 19/27] test: now should pass

---
 README.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/README.md b/README.md
index 3a4c2830de1..991d0e3a23b 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,6 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
-| [duplicatewrongname](./packages/ui-lib)                                                   | UI library. |
 
 
 ## Issues

From b1602d04fc1e349ff2fa33660eff8b32ff5b8eb9 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:55:52 -0500
Subject: [PATCH 20/27] test: should fail

---
 packages/new-package/kitty | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 packages/new-package/kitty

diff --git a/packages/new-package/kitty b/packages/new-package/kitty
new file mode 100644
index 00000000000..45b983be36b
--- /dev/null
+++ b/packages/new-package/kitty
@@ -0,0 +1 @@
+hi

From db1d9b38e51988a1b25bc25b291f587d0802172b Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:56:34 -0500
Subject: [PATCH 21/27] test: should fail

---
 .github/workflows/repo--validate-package-docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index 5fec9abfec0..051d1088572 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -11,7 +11,7 @@ jobs:
   validate:
     runs-on: ubuntu-latest
     env:
-      EXPECTED_PACKAGE_COUNT: 18  # Update this when packages are added/removed
+      EXPECTED_PACKAGE_COUNT: 19  # Update this when packages are added/removed
     steps:
       - uses: actions/checkout@v4
 

From be1840da6d795a8d4fca382cdcc1acf4cd59e29c Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:57:39 -0500
Subject: [PATCH 22/27] test: should fail

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 991d0e3a23b..425827d9c4e 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,7 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
+| [new-package](./packages/new-package)                                         | new package |
 
 
 ## Issues

From 34612b587e9dc61f0e95c4650493a364421ffcc3 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:58:27 -0500
Subject: [PATCH 23/27] test: should pass

---
 packages/new-package/README.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 packages/new-package/README.md

diff --git a/packages/new-package/README.md b/packages/new-package/README.md
new file mode 100644
index 00000000000..45b983be36b
--- /dev/null
+++ b/packages/new-package/README.md
@@ -0,0 +1 @@
+hi

From 4427dfab651b490c1794a7c305f065374974caab Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 12:59:59 -0500
Subject: [PATCH 24/27] test: cleanup, should pass

---
 .github/workflows/repo--validate-package-docs.yml | 2 +-
 README.md                                         | 1 -
 packages/new-package/README.md                    | 1 -
 packages/new-package/kitty                        | 1 -
 4 files changed, 1 insertion(+), 4 deletions(-)
 delete mode 100644 packages/new-package/README.md
 delete mode 100644 packages/new-package/kitty

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index 051d1088572..5fec9abfec0 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -11,7 +11,7 @@ jobs:
   validate:
     runs-on: ubuntu-latest
     env:
-      EXPECTED_PACKAGE_COUNT: 19  # Update this when packages are added/removed
+      EXPECTED_PACKAGE_COUNT: 18  # Update this when packages are added/removed
     steps:
       - uses: actions/checkout@v4
 
diff --git a/README.md b/README.md
index 425827d9c4e..991d0e3a23b 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,6 @@ Get started with Taiko:
 | [taiko-client](./packages/taiko-client)                                       | Taiko client implementation in Go. |
 | [taikoon-ui](./packages/taikoon-ui)                                           | Taikoon UI. |
 | [ui-lib](./packages/ui-lib)                                                   | UI library. |
-| [new-package](./packages/new-package)                                         | new package |
 
 
 ## Issues
diff --git a/packages/new-package/README.md b/packages/new-package/README.md
deleted file mode 100644
index 45b983be36b..00000000000
--- a/packages/new-package/README.md
+++ /dev/null
@@ -1 +0,0 @@
-hi
diff --git a/packages/new-package/kitty b/packages/new-package/kitty
deleted file mode 100644
index 45b983be36b..00000000000
--- a/packages/new-package/kitty
+++ /dev/null
@@ -1 +0,0 @@
-hi

From 616c8d33350ca90c1e78b7fdee56732555da6e49 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 13:03:17 -0500
Subject: [PATCH 25/27] test: confirm no trigger

---
 packages/docs-site/kitty | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 packages/docs-site/kitty

diff --git a/packages/docs-site/kitty b/packages/docs-site/kitty
new file mode 100644
index 00000000000..e69de29bb2d

From f634c25611a38c7dc18056ea2850be3629d75b28 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 13:10:25 -0500
Subject: [PATCH 26/27] update path filter

---
 .github/workflows/repo--validate-package-docs.yml | 5 +++--
 packages/docs-site/kitty                          | 0
 2 files changed, 3 insertions(+), 2 deletions(-)
 delete mode 100644 packages/docs-site/kitty

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
index 5fec9abfec0..71a0b8e0bf1 100644
--- a/.github/workflows/repo--validate-package-docs.yml
+++ b/.github/workflows/repo--validate-package-docs.yml
@@ -4,8 +4,9 @@ name: Validate Package Docs
 on:
   pull_request:
     paths:
-      - '**/README.md'
-      - 'packages/*/'
+      - 'README.md'
+      - 'packages'        # Catch changes to packages directory itself
+      - '!packages/**/*'  # But ignore all changes inside packages
 
 jobs:
   validate:
diff --git a/packages/docs-site/kitty b/packages/docs-site/kitty
deleted file mode 100644
index e69de29bb2d..00000000000

From 8da582e6a2b0f11c3b5d376137d0cd24ec8324c4 Mon Sep 17 00:00:00 2001
From: dionysuz <13951458+dionysuzx@users.noreply.github.com>
Date: Mon, 23 Dec 2024 13:18:10 -0500
Subject: [PATCH 27/27] remove logic

---
 .../workflows/repo--validate-package-docs.yml | 69 -------------------
 1 file changed, 69 deletions(-)
 delete mode 100644 .github/workflows/repo--validate-package-docs.yml

diff --git a/.github/workflows/repo--validate-package-docs.yml b/.github/workflows/repo--validate-package-docs.yml
deleted file mode 100644
index 71a0b8e0bf1..00000000000
--- a/.github/workflows/repo--validate-package-docs.yml
+++ /dev/null
@@ -1,69 +0,0 @@
----
-name: Validate Package Docs
-
-on:
-  pull_request:
-    paths:
-      - 'README.md'
-      - 'packages'        # Catch changes to packages directory itself
-      - '!packages/**/*'  # But ignore all changes inside packages
-
-jobs:
-  validate:
-    runs-on: ubuntu-latest
-    env:
-      EXPECTED_PACKAGE_COUNT: 18  # Update this when packages are added/removed
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Validate packages
-        run: |
-          # Get current package count
-          CURRENT_COUNT=$(ls -d packages/*/ | wc -l | tr -d ' ')
-          if [ "$CURRENT_COUNT" != "$EXPECTED_PACKAGE_COUNT" ]; then
-            echo "❌ Package count mismatch! Expected $EXPECTED_PACKAGE_COUNT but found $CURRENT_COUNT"
-            echo "Update EXPECTED_PACKAGE_COUNT in workflow if this was intentional"
-            exit 1
-          fi
-
-          # Extract packages section and find table entries
-          PACKAGES=$(ls -d packages/*/ | cut -f2 -d'/' | sort)
-          PACKAGE_PATHS=$(sed -n '/^## Packages$/,/^## /p' README.md | tr -d '\n' | grep -o '|\s*\[.*\]([^)]*/packages/[^)]*)'  | grep -o '/packages/[^)]*')
-          README_PACKAGES=$(echo "$PACKAGE_PATHS" | sed -E 's/.*packages\/([^/)]*).*/\1/' | sort | uniq)
-
-          # Check table row count matches expected
-          TABLE_ROW_COUNT=$(echo "$PACKAGE_PATHS" | wc -l | tr -d ' ')
-          if [ "$TABLE_ROW_COUNT" != "$EXPECTED_PACKAGE_COUNT" ]; then
-            echo "❌ Table row count mismatch! Expected $EXPECTED_PACKAGE_COUNT rows but found $TABLE_ROW_COUNT"
-            echo "Make sure there are no extra or missing rows in the packages table"
-            exit 1
-          fi
-
-          if [ -z "$README_PACKAGES" ]; then
-            echo "❌ No package entries found in README.md table. Table might be malformed."
-            exit 1
-          fi
-
-          # Check for mismatches
-          MISSING_IN_README=$(comm -23 <(echo "$PACKAGES") <(echo "$README_PACKAGES"))
-          EXTRA_IN_README=$(comm -13 <(echo "$PACKAGES") <(echo "$README_PACKAGES"))
-
-          if [ ! -z "$MISSING_IN_README" ]; then
-            echo "❌ Packages not documented in README.md: $MISSING_IN_README"
-            exit 1
-          fi
-
-          if [ ! -z "$EXTRA_IN_README" ]; then
-            echo "❌ Non-existent packages in README.md: $EXTRA_IN_README"
-            exit 1
-          fi
-
-          # Check for missing READMEs
-          for pkg in packages/*/; do
-            if [ ! -f "${pkg}README.md" ]; then
-              echo "❌ Missing README.md in ${pkg}"
-              exit 1
-            fi
-          done
-
-          echo "✅ All package documentation is valid"