feat(docs-site): add software releases page that shows latest softwar…

…e releases and protocol deployments (#18523)
taikoxyz · Nov 26, 2024 · 23862a2 · 23862a2
1 parent 385fed2
commit 23862a2
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 13 deletions.
diff --git a/_typos.toml b/_typos.toml
@@ -18,6 +18,9 @@ extend-exclude = [
   "*.png",
   "*.svg",
   "go.mod",
+  "go.sum",
+  "pnpm-lock.yaml",
+  "**/**/pnpm-lock.yaml",
   "CHANGELOG.md",
   "packages/protocol/audit/code4rena-2024-03-taiko-final-report.md",
   "packages/protocol/contracts/layer1/automata-attestation/**",

diff --git a/packages/docs-site/astro.config.ts b/packages/docs-site/astro.config.ts
@@ -190,8 +190,8 @@ export default defineConfig({
               link: "/network-reference/network-configuration",
             },
             {
-              label: "Node releases",
-              link: "/network-reference/node-releases",
+              label: "Software releases",
+              link: "/network-reference/software-releases-and-deployments",
             },
             {
               label: "RPC configuration",

diff --git a/packages/docs-site/src/content/docs/network-reference/node-releases.md b/packages/docs-site/src/content/docs/network-reference/node-releases.md
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
@@ -0,0 +1,26 @@
+---
+title: Software releases and Deployments
+description: Network reference page displaying the latest software versions.
+---
+
+## Software Releases
+
+It is **highly recommended** you use the latest software. You can find the latest versions here:
+
+| Package                                                                                | Release notes                                                                                                                                                                                     |
+| :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [protocol](https://github.com/taikoxyz/taiko-mono/tree/main/packages/protocol) | [![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) |
+| [taiko-geth](https://github.com/taikoxyz/taiko-geth)                                   | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-geth?label=)](https://github.com/taikoxyz/taiko-geth/blob/taiko/CHANGELOG.md) |
+| [taiko-client](https://github.com/taikoxyz/taiko-mono/tree/main/packages/taiko-client) | [![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) |
+| [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
+
+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
+
+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).