docs(repo, docs-site): add release info links (#17819)

taikoxyz · Jul 20, 2024 · c268467 · c268467
1 parent a82326e
commit c268467
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 38 deletions.
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -8,10 +8,9 @@
   "packages/guardian-prover-health-check-ui": "0.1.0",
   "packages/protocol": "1.8.0",
   "packages/relayer": "0.12.0",
-  "packages/taiko-client": "0.29.0",
-  "packages/nfts": "1.0.0",
+  "packages/snaefell-ui": "1.1.0",
   "packages/supplementary-contracts": "1.0.0",
+  "packages/taiko-client": "0.29.0",
   "packages/taikoon-ui": "1.2.0",
-  "packages/ui-lib": "1.0.0",
-  "packages/snaefell-ui": "1.1.0"
+  "packages/ui-lib": "1.0.0"
 }
diff --git a/README.md b/README.md
@@ -23,34 +23,35 @@
 
 ## Documentation
 
-End user documentation can be found at [docs.taiko.xyz](https://docs.taiko.xyz). Protocol specs can be found [here](./packages/protocol/docs/README.md).
-
-Each package of the monorepo is well documented and includes a README.
-
-## Project structure
-
-<pre>
-taiko-mono/
-├── <a href="./CHANGELOG.md">CHANGELOG.md</a>
-├── <a href="./CONTRIBUTING.md">CONTRIBUTING.md</a>
-├── <a href="./LICENSE.md">LICENSE.md</a>
-├── <a href="./README.md">README.md</a>
-├── <a href="./packages">packages</a>
-│   ├── <a href="./packages/branding">branding</a>: Taiko branding materials.
-│   ├── <a href="./packages/bridge-ui">bridge-ui</a>: Bridge UI.
-│   ├── <a href="./packages/docs-site">docs-site</a>: End user documentation site.
-│   ├── <a href="./packages/eventindexer">eventindexer</a>: Event indexer.
-│   ├── <a href="./packages/fork-diff">fork-diff</a>: Fork diff page.
-│   ├── <a href="./packages/guardian-prover-health-check">guardian-prover-health-check</a>: Guardian prover health check service.
-│   ├── <a href="./packages/guardian-prover-health-check-ui">guardian-prover-health-check-ui</a>: Guardian prover health check UI.
-│   ├── <a href="./packages/protocol">protocol</a>: Taiko protocol smart contracts.
-│   ├── <a href="./packages/relayer">relayer</a>: Bridge backend relayer.
-│   ├── <a href="./packages/supplementary-contracts">supplementary-contracts</a>: Supplementary smart contracts that are not part of the Taiko rollup protocol.
-│   ├── <a href="./packages/taiko-client">taiko-client</a>: Taiko client implementation in Go.
-│   ├── <a href="./packages/nfts">nfts</a>: Taiko NFTs.
-│   └── <a href="./packages/taikoon-ui">taikoon-ui</a>: Taikoon NFT UI.
-...
-</pre>
+Get started with Taiko:
+
+- [Taiko docs](https://docs.taiko.xyz) — High-level concepts, guides, resources, and reference pages for getting started.
+- [Protocol specs](./packages/protocol/docs/README.md) — In-depth specifications of the Taiko protocol for deeper understanding.
+- [Smart contracts](./packages/protocol/contracts/) — Taiko protocol smart contracts, fully documented with NatSpec.
+
+## Packages
+
+<!-- uncomment after release docs-site
+> [!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                                                                                                                                                                                                                           |
+| :---------------------------------------------------------------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [branding](./packages/branding)                                               | Taiko branding materials.                               | [![GitHub Release](https://img.shields.io/github/v/release/taikoxyz/taiko-mono?filter=branding*&label=)](https://github.com/taikoxyz/taiko-mono/blob/main/packages/branding/CHANGELOG.md)                                               |
+| [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)                                                   |
 
 ## Issues
 

diff --git a/packages/docs-site/astro.config.ts b/packages/docs-site/astro.config.ts
@@ -41,7 +41,8 @@ export default defineConfig({
       },
       title: "Docs",
       editLink: {
-        baseUrl: "https://github.com/taikoxyz/taiko-mono/tree/main/packages/docs-site",
+        baseUrl:
+          "https://github.com/taikoxyz/taiko-mono/tree/main/packages/docs-site",
       },
       customCss: ["./src/styles/custom.css"],
       logo: {
@@ -106,8 +107,14 @@ export default defineConfig({
                   label: "Set up your wallet",
                   link: "/guides/app-developers/set-up-your-wallet/",
                 },
-                { label: "Receive tokens", link: "/guides/app-developers/receive-tokens/" },
-                { label: "Bridge tokens", link: "/guides/app-developers/bridge-tokens/" },
+                {
+                  label: "Receive tokens",
+                  link: "/guides/app-developers/receive-tokens/",
+                },
+                {
+                  label: "Bridge tokens",
+                  link: "/guides/app-developers/bridge-tokens/",
+                },
                 {
                   label: "Deploy a contract",
                   link: "/guides/app-developers/deploy-a-contract/",
@@ -153,7 +160,7 @@ export default defineConfig({
                 },
                 {
                   label: "Deploy a ProverSet",
-                  link: "guides/node-operators/deploy-a-proverset/"
+                  link: "guides/node-operators/deploy-a-proverset/",
                 },
                 {
                   label: "Node troubleshooting",
@@ -182,6 +189,10 @@ export default defineConfig({
               label: "Network configuration",
               link: "/network-reference/network-configuration",
             },
+            {
+              label: "Node releases",
+              link: "/network-reference/node-releases",
+            },
             {
               label: "RPC configuration",
               link: "/network-reference/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
@@ -0,0 +1,11 @@
+---
+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/release-please-config.json b/release-please-config.json
@@ -18,7 +18,9 @@
   "packages": {
     "packages/branding": {},
     "packages/bridge-ui": {},
-    "packages/docs-site": {},
+    "packages/docs-site": {
+      "prerelease": true
+    },
     "packages/eventindexer": {},
     "packages/fork-diff": {},
     "packages/guardian-prover-health-check": {},
@@ -27,7 +29,9 @@
     "packages/relayer": {},
     "packages/nfts": {},
     "packages/taikoon-ui": {},
-    "packages/taiko-client": {},
+    "packages/taiko-client": {
+      "prerelease": true
+    },
     "packages/supplementary-contracts": {},
     "packages/ui-lib": {},
     "packages/snaefell-ui": {}