From 23862a26890492231cdbf5dd07366e294debda99 Mon Sep 17 00:00:00 2001 From: Roger <50648015+RogerLamTd@users.noreply.github.com> Date: Tue, 26 Nov 2024 04:14:42 -0800 Subject: [PATCH] feat(docs-site): add software releases page that shows latest software releases and protocol deployments (#18523) --- _typos.toml | 3 +++ packages/docs-site/astro.config.ts | 4 +-- .../docs/network-reference/node-releases.md | 11 -------- .../software-releases-and-deployments.md | 26 +++++++++++++++++++ 4 files changed, 31 insertions(+), 13 deletions(-) delete mode 100644 packages/docs-site/src/content/docs/network-reference/node-releases.md create mode 100644 packages/docs-site/src/content/docs/network-reference/software-releases-and-deployments.md diff --git a/_typos.toml b/_typos.toml index 004806bd6cf..b854bc37085 100644 --- 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 index 479104944e6..5f7c4d44faf 100644 --- 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 deleted file mode 100644 index c0c21dfbf5a..00000000000 --- a/packages/docs-site/src/content/docs/network-reference/node-releases.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Node releases -description: Network reference page displaying the latest node software versions. ---- - -It is **highly recommended** you use the latest node software. You can find the latest versions here: - -| Package | Release notes | -| :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [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) | -| [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) | diff --git a/packages/docs-site/src/content/docs/network-reference/software-releases-and-deployments.md b/packages/docs-site/src/content/docs/network-reference/software-releases-and-deployments.md new file mode 100644 index 00000000000..336964cf320 --- /dev/null +++ b/packages/docs-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).