docs(website): add relayer and eventindexer swagger docs, add back sw…

…ap guide (#14969)
taikoxyz · Oct 16, 2023 · f60448e · f60448e
1 parent f47509f
commit f60448e
Show file tree

Hide file tree

Showing 8 changed files with 541 additions and 489 deletions.
diff --git a/packages/website/package.json b/packages/website/package.json
@@ -19,13 +19,13 @@
   },
   "devDependencies": {
     "@heroicons/react": "^2.0.18",
-    "@types/node": "^20.8.3",
-    "@types/react": "^18.2.25",
+    "@types/node": "^20.8.6",
+    "@types/react": "^18.2.28",
     "autoprefixer": "^10.4.16",
     "daisyui": "^3.9.2",
     "postcss": "^8.4.31",
     "tailwindcss": "^3.3.3",
     "typescript": "^5.2.2",
-    "viem": "^1.16.0"
+    "viem": "^1.16.5"
   }
 }
diff --git a/packages/website/pages/docs/guides.mdx b/packages/website/pages/docs/guides.mdx
@@ -8,7 +8,7 @@ Check out our guides below. You can leave feedback [here](https://forms.gle/TAnV
   <Card title="💰 Setup your wallet" href="/docs/guides/setup-your-wallet" />
   <Card title="🎁 Receive tokens" href="/docs/guides/receive-tokens" />
   <Card title="🌉 Bridge tokens" href="/docs/guides/bridge-tokens" />
-  {/* <Card title="🔄 Swap tokens" href="/docs/guides/swap-tokens" /> */}
+  <Card title="🔄 Swap tokens" href="/docs/guides/swap-tokens" />
   <Card title="🚀 Deploy a contract" href="/docs/guides/deploy-a-contract" />
   <Card title="📜 Verify a contract" href="/docs/guides/verify-a-contract" />
   <Card title="🔷 Run a Sepolia node" href="/docs/guides/run-a-sepolia-node" />

diff --git a/packages/website/pages/docs/guides/_meta.json b/packages/website/pages/docs/guides/_meta.json
@@ -9,8 +9,7 @@
     "title": "🌉 Bridge tokens"
   },
   "swap-tokens": {
-    "title": "🔄 Swap tokens",
-    "display": "hidden"
+    "title": "🔄 Swap tokens"
   },
   "deploy-a-contract": {
     "title": "🚀 Deploy a contract"

diff --git a/packages/website/pages/docs/guides/swap-tokens.mdx b/packages/website/pages/docs/guides/swap-tokens.mdx
@@ -2,7 +2,7 @@ import { Callout, Steps } from "nextra-theme-docs";
 
 # Swap tokens
 
-This guide will help you interact with Swap, which is a fork of Uniswap v2 that Taiko has deployed only for testing purposes.
+This guide will help you interact with Swap V3, which is a fork of Uniswap V3 that Taiko has deployed only for testing purposes.
 
 ## Prerequisites
 
@@ -13,7 +13,7 @@ This guide will help you interact with Swap, which is a fork of Uniswap v2 that
 <Steps>
     ### Visit Swap
 
-    Visit the [Swap dapp](https://swap.jolnir.taiko.xyz).
+    Visit the [Swap V3 dapp](https://swap-v3.jolnir.taiko.xyz).
 
     ### Follow the video guide for swapping tokens
 

diff --git a/packages/website/pages/docs/reference/event-indexer.mdx b/packages/website/pages/docs/reference/event-indexer.mdx
@@ -0,0 +1,3 @@
+# Event indexer
+
+You can view API docs to build with our event indexer here: https://eventindexer-swagger.taiko.xyz.
diff --git a/packages/website/pages/docs/reference/relayer.mdx b/packages/website/pages/docs/reference/relayer.mdx
@@ -0,0 +1,3 @@
+# Relayer
+
+You can view API docs to build with our relayer here: https://relayer-swagger.taiko.xyz.
diff --git a/packages/website/theme.config.tsx b/packages/website/theme.config.tsx
@@ -21,9 +21,8 @@ export default {
   docsRepositoryBase:
     "https://github.com/taikoxyz/taiko-mono/blob/main/packages/website",
   editLink: {
-    text: "Edit this page ↗",
+    text: "Edit this page 📝",
   },
-  // TODO: we should add the feedback link, check if nextra fixed it: https://github.com/shuding/nextra/issues/2067
   feedback: {
     content: (
       <button
@@ -36,7 +35,7 @@ export default {
           if (win) win.opener = null;
         }}
       >
-        Leave feedback ↗
+        Leave feedback 💬
       </button>
     ),
   },
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Event indexer

		You can view API docs to build with our event indexer here: https://eventindexer-swagger.taiko.xyz.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Relayer

		You can view API docs to build with our relayer here: https://relayer-swagger.taiko.xyz.