diff --git a/packages/website/components/Footer.tsx b/packages/website/components/Footer.tsx index 84c68d874f0..21b0716d0c2 100644 --- a/packages/website/components/Footer.tsx +++ b/packages/website/components/Footer.tsx @@ -1,131 +1,120 @@ -import { ThemeSwitch, useConfig } from "nextra-theme-docs"; - -export default function Footer({ menu }) { - const config = useConfig(); - +export default function Footer() { return ( ); } diff --git a/packages/website/components/Hero.tsx b/packages/website/components/Hero.tsx index 8a1a6e44725..5158ea24eaf 100644 --- a/packages/website/components/Hero.tsx +++ b/packages/website/components/Hero.tsx @@ -37,41 +37,43 @@ export default function Hero() { } return ( -
-
-
-
-

- A Type 1 ZK-EVM -

-

- Fully decentralized, Ethereum-equivalent ZK-Rollup. -

-
-
- - Explore Snæfellsjökull Testnet 🌋 - +
+
+
+
+
+

+ A Type 1 ZK-EVM +

+

+ Fully decentralized, Ethereum-equivalent ZK-Rollup. +

+
-
-
- -
-
+
+ +
+ +
); } diff --git a/packages/website/pages/_meta.json b/packages/website/pages/_meta.json index 8a62f9c79ed..75e7d644345 100644 --- a/packages/website/pages/_meta.json +++ b/packages/website/pages/_meta.json @@ -17,8 +17,8 @@ "href": "https://mirror.xyz/labs.taiko.eth", "newWindow": true }, - "Snæfellsjökull": { - "title": "Snæfellsjökull Testnet", + "testnet-links-dropdown": { + "title": "Testnet Links", "type": "menu", "items": { "status": { diff --git a/packages/website/pages/docs/_meta.json b/packages/website/pages/docs/_meta.json index 7ac6c63155e..3d9d896c02a 100644 --- a/packages/website/pages/docs/_meta.json +++ b/packages/website/pages/docs/_meta.json @@ -1,12 +1,12 @@ { "index": { - "title": "Introduction" + "title": "Introduction 👋" }, "learn": { "title": "Learn" }, "testnet-guide": { - "title": "Alpha-1 Testnet Guide" + "title": "Guides" }, "reference": { "title": "Reference" diff --git a/packages/website/pages/docs/index.md b/packages/website/pages/docs/index.md index 0741481928b..3af024f4155 100644 --- a/packages/website/pages/docs/index.md +++ b/packages/website/pages/docs/index.md @@ -2,11 +2,46 @@ Taiko is a fully decentralized, Ethereum-equivalent ZK-Rollup. This is also referred to as a [Type 1 ZK-EVM](https://mirror.xyz/labs.taiko.eth/w7NSKDeKfJoEy0p89I9feixKfdK-20JgWF9HZzxfeBo). -### Testnet guide +And welcome to the official Taiko documentation! This is your one-stop shop for all things Taiko. You will finds: -Follow the [Alpha-1 testnet guide](/docs/testnet-guide/) to get started with using Taiko. +- **Learn**: Learn about how Taiko works +- **Guides**: Easy to follow guides to build on and use Taiko +- **Reference**: Quick reference documentation about the network (e.g., contract addresses, protocol configurations) +- **Resources**: Additional resources for your knowledge -### Learn more +## The Alpha-1 (Snæfellsjökull) Testnet + +There are two networks involved in the alpha-1 testnet: + +- **Taiko A1** is the Alpha-1 testnet release of Taiko: A fully decentralized, Ethereum-equivalent ZK-Rollup. +- **Ethereum A1** is Taiko's privately deployed Ethereum network, which serves as the L1 for Taiko's Alpha-1 testnet. + +The testnet consists of L1 / L2 nodes with all of the Taiko protocol contracts deployed. The mining interval of the L1 node is set to 12 seconds. There is also a cron job service that proposes empty blocks every two minutes. + +### Use the testnet + +In this testnet, you can: + +- 🌉 Bridge tokens between Ethereum A1 and Taiko A1. +- 🤝 Send transactions (e.g., deploy a dapp, interact with a contract). +- 🌐 Run a node—this makes **you** a part of Taiko! + +Check out the guides in the left sidebar to use the testnet! + +### Navigate the testnet + +All the relevant links can be found in this site's navigation bar at the top. The relevant links are: + +| Link | Purpose | +| ----------------------------------------------- | -------------------------------------------------- | +| [Status](https://status.a1.taiko.xyz/) | Taiko protocol status | +| [Bridge](https://bridge.a1.taiko.xyz/) | Bridge ETH/tokens between Ethereum A1 and Taiko A1 | +| [L1 faucet](https://l1faucet.a1.taiko.xyz/) | For receiving ETH on Ethereum A1 | +| [L2 faucet](https://l2faucet.a1.taiko.xyz/) | For receiving ETH on Taiko A1 | +| [L1 explorer](https://l1explorer.a1.taiko.xyz/) | Explore blocks on Ethereum A1 | +| [L2 explorer](https://l2explorer.a1.taiko.xyz/) | Explore blocks on Taiko A1 | + +## Learn more about Taiko This documentation website is currently under construction 🚧. In the meantime, you can check out these resources: diff --git a/packages/website/pages/docs/learn/_meta.json b/packages/website/pages/docs/learn/_meta.json index b9780edad4f..2d9f4821405 100644 --- a/packages/website/pages/docs/learn/_meta.json +++ b/packages/website/pages/docs/learn/_meta.json @@ -1,6 +1,6 @@ { - "overview": { - "title": "Overview" + "block-proposal-and-verification": { + "title": "Block proposal & verification" }, "bridge": { "title": "Bridge" diff --git a/packages/website/pages/docs/learn/overview.md b/packages/website/pages/docs/learn/block-proposal-and-verification.md similarity index 98% rename from packages/website/pages/docs/learn/overview.md rename to packages/website/pages/docs/learn/block-proposal-and-verification.md index 68f0304c176..7820002f1f6 100644 --- a/packages/website/pages/docs/learn/overview.md +++ b/packages/website/pages/docs/learn/block-proposal-and-verification.md @@ -1,4 +1,4 @@ -# Overview +# Block proposal & verification Taiko aims to build a secure, decentralized, and permissionless rollup on Ethereum. These requirements dictate the following properties: diff --git a/packages/website/pages/docs/resources/_meta.json b/packages/website/pages/docs/resources/_meta.json index 6f92dc28f4f..9a453ad3591 100644 --- a/packages/website/pages/docs/resources/_meta.json +++ b/packages/website/pages/docs/resources/_meta.json @@ -5,6 +5,9 @@ "faqs": { "title": "FAQs" }, + "get-help": { + "title": "Get help" + }, "presentations": { "title": "Presentations" }, diff --git a/packages/website/pages/docs/testnet-guide/get-help.md b/packages/website/pages/docs/resources/get-help.md similarity index 68% rename from packages/website/pages/docs/testnet-guide/get-help.md rename to packages/website/pages/docs/resources/get-help.md index 9bd5dd33fe9..465e8b2cea9 100644 --- a/packages/website/pages/docs/testnet-guide/get-help.md +++ b/packages/website/pages/docs/resources/get-help.md @@ -1,3 +1,3 @@ -# ❓ Get help +# Get help -Reach out to the community on [Discord](https://discord.gg/taikoxyz) for help. +Reach out to the community on [Discord](https://discord.gg/taikoxyz) for help! diff --git a/packages/website/pages/docs/testnet-guide/_meta.json b/packages/website/pages/docs/testnet-guide/_meta.json index 6aa5c79df65..0988d776c57 100644 --- a/packages/website/pages/docs/testnet-guide/_meta.json +++ b/packages/website/pages/docs/testnet-guide/_meta.json @@ -1,23 +1,17 @@ { - "index": { - "title": "👋 Start here" - }, "configure-wallet": { - "title": "⚙️ Configure your wallet" + "title": "Configure your wallet" }, "request-from-faucet": { - "title": "💧 Request from faucet" + "title": "Request from faucet" }, "use-the-bridge": { - "title": "🌉 Use the bridge" + "title": "Use the bridge" }, "deploy-a-contract": { - "title": "🚀 Deploy a contract" + "title": "Deploy a basic contract" }, "run-a-node": { - "title": "🌐 Run a Taiko node" - }, - "get-help": { - "title": "❓ Get help" + "title": "Run a Taiko node" } } diff --git a/packages/website/pages/docs/testnet-guide/index.md b/packages/website/pages/docs/testnet-guide/index.md deleted file mode 100644 index e0398dd7224..00000000000 --- a/packages/website/pages/docs/testnet-guide/index.md +++ /dev/null @@ -1,29 +0,0 @@ -# Start here - -Welcome to Taiko's Alpha-1 testnet, **Snæfellsjökull**. There are two networks involved in the testnet: - -- **Taiko A1** is the Alpha-1 testnet release of Taiko: A fully decentralized, Ethereum-equivalent ZK-Rollup. -- **Ethereum A1** is Taiko's privately deployed Ethereum network, which serves as the L1 for Taiko's Alpha-1 testnet. - -The testnet consists of L1 / L2 nodes with all of the Taiko protocol contracts deployed. The mining interval of the L1 node is set to 12 seconds. There is also a cron job service that proposes empty blocks every two minutes. - -## Use the testnet - -In this testnet, you can: - -- 🌉 Bridge tokens between Ethereum A1 and Taiko A1. -- 🤝 Send transactions (e.g., deploy a dapp, interact with a contract). -- 🌐 Run a node—this makes **you** a part of Taiko! - -## Navigate the testnet - -All the relevant links can be found in this site's navigation. The relevant links are: - -| Link | Purpose | -| ----------------------------------------------- | -------------------------------------------------- | -| [Status](https://status.a1.taiko.xyz/) | Taiko protocol status | -| [Bridge](https://bridge.a1.taiko.xyz/) | Bridge ETH/tokens between Ethereum A1 and Taiko A1 | -| [L1 faucet](https://l1faucet.a1.taiko.xyz/) | For receiving ETH on Ethereum A1 | -| [L2 faucet](https://l2faucet.a1.taiko.xyz/) | For receiving ETH on Taiko A1 | -| [L1 explorer](https://l1explorer.a1.taiko.xyz/) | Explore blocks on Ethereum A1 | -| [L2 explorer](https://l2explorer.a1.taiko.xyz/) | Explore blocks on Taiko A1 | diff --git a/packages/website/theme.config.tsx b/packages/website/theme.config.tsx index b0cf3dec507..c6f1d9cb5c6 100644 --- a/packages/website/theme.config.tsx +++ b/packages/website/theme.config.tsx @@ -4,6 +4,18 @@ import Footer from "./components/Footer"; import ThemedImage from "./components/ThemedImage"; export default { + banner: { + key: "banner", + text: ( + + 📌 The alpha-1 testnet (Snæfellsjökull) will be deprecated on February + 15th, around 14:00UTC. Read more → + + ), + }, chat: { link: "https://discord.gg/taikoxyz", },