New footer and removes pages (#618)

* fixes discussions link * new footer * removes community resources * removes videos and important links * fixes warning message * fixes hardcoded compiler version * Update docs/.vuepress/styles/index.scss Co-authored-by: Dustin Brickwood <[email protected]> * Update docs/.vuepress/styles/index.scss Co-authored-by: Dustin Brickwood <[email protected]> --------- Co-authored-by: Dustin Brickwood <[email protected]>
matter-labs · Jul 3, 2023 · e5daacf · e5daacf
1 parent 10cefa5
commit e5daacf
Show file tree

Hide file tree

Showing 15 changed files with 282 additions and 366 deletions.
diff --git a/docs/.vuepress/components/PageFooter.vue b/docs/.vuepress/components/PageFooter.vue
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -1,18 +1,14 @@
 import { defineUserConfig } from "vuepress";
 import docsearchPlugin from "@vuepress/plugin-docsearch";
-import vue from '@vitejs/plugin-vue'
+import vue from "@vitejs/plugin-vue";
 import theme from "./theme.js";
 import { pwaPlugin } from "vuepress-plugin-pwa2";
-import { getDirname, path } from "@vuepress/utils"
+import { getDirname, path } from "@vuepress/utils";
 
 const dirname = getDirname(import.meta.url);
 
 export default defineUserConfig({
   alias: {
-    '@theme-hope/components/PageFooter': path.resolve(
-      dirname,
-      './components/PageFooter.vue',
-    ),
     "@theme-hope/modules/navbar/components/Navbar": path.resolve(__dirname, "./components/NavBar.vue"),
   },
   dest: "dist/docs",
@@ -21,40 +17,61 @@ export default defineUserConfig({
   title: "Welcome to our Docs | zkSync Era",
 
   head: [
-    ['link', { rel: 'canonical', href: 'https://era.zksync.io/docs/' }],
-    ['link', { rel: 'preconnect', href: 'https://fonts.googleapis.com' }],
-    ['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: true }],
-    ['link', { rel: 'stylesheet', href: 'https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700&display=swap' }],
-    ['meta', { name: "keywords", content: "Documentation, Developers, Era, zkSync, Matter Labs, rollup, ZK rollup, zero confirmation, ZKP, zero-knowledge proofs, Ethereum, crypto, blockchain, permissionless, L2, secure payments, scalable" }],
-    ['meta', { name: "description", content: "zkSync Era is a user-centric zk rollup platform from Matter Labs. It is a scaling solution for Ethereum, already live on Ethereum mainnet" }],
-    ['meta', { name: "author", content: "https://matter-labs.io" }], 
-
-    ['meta', { name: "og:image", content: "https://era.zksync.io/docs/share_image.png" }],
-    ['meta', { property: 'og:image', content: 'https://era.zksync.io/docs/share_image.png' }],
-    ['meta', { name: "og:image:secure_url", content: "https://era.zksync.io/docs/share_image.png" }],
-    ['meta', { name: "og:url", content: "https://era.zksync.io/docs/" }],
-    ['meta', { name: "og:image:alt", content: "zkSync — Accelerating the mass adoption of crypto for personal sovereignty" }],
-    ['meta', { property: "og:title", content: "Welcome to our Docs | zkSync Era" }],
-    ['meta', { name: "og:description", content: "zkSync Era is a user-centric zk rollup platform from Matter Labs. It is a scaling solution for Ethereum, already live on Ethereum mainnet." }],
+    ["link", { rel: "canonical", href: "https://era.zksync.io/docs/" }],
+    ["link", { rel: "preconnect", href: "https://fonts.googleapis.com" }],
+    ["link", { rel: "preconnect", href: "https://fonts.gstatic.com", crossorigin: true }],
+    ["link", { rel: "stylesheet", href: "https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700&display=swap" }],
+    [
+      "meta",
+      {
+        name: "keywords",
+        content:
+          "Documentation, Developers, Era, zkSync, Matter Labs, rollup, ZK rollup, zero confirmation, ZKP, zero-knowledge proofs, Ethereum, crypto, blockchain, permissionless, L2, secure payments, scalable",
+      },
+    ],
+    [
+      "meta",
+      { name: "description", content: "zkSync Era is a user-centric zk rollup platform from Matter Labs. It is a scaling solution for Ethereum, already live on Ethereum mainnet" },
+    ],
+    ["meta", { name: "author", content: "https://matter-labs.io" }],
 
-    ['meta', { name: "twitter:card", content: "summary" }],
-    ['meta', { name: "twitter:title", content: "Welcome to our Docs | zkSync Era" }],
-    ['meta', { name: "twitter:description", content: "zkSync Era is a user-centric zk rollup platform from Matter Labs. It is a scaling solution for Ethereum, already live on Ethereum mainnet." }],
-    ['meta', { name: "twitter:image", content: "https://era.zksync.io/docs/share_image.png" }],
-    ['meta', { name: "twitter:site", content: "@zksync" }],
-    ['meta', { name: "twitter:creator", content: "@the_matter_labs" }],
-    ['meta', { name: "twitter:image:alt", content: "zkSync — Accelerating the mass adoption of crypto for personal sovereignty" }],
+    ["meta", { name: "og:image", content: "https://era.zksync.io/docs/share_image.png" }],
+    ["meta", { property: "og:image", content: "https://era.zksync.io/docs/share_image.png" }],
+    ["meta", { name: "og:image:secure_url", content: "https://era.zksync.io/docs/share_image.png" }],
+    ["meta", { name: "og:url", content: "https://era.zksync.io/docs/" }],
+    ["meta", { name: "og:image:alt", content: "zkSync — Accelerating the mass adoption of crypto for personal sovereignty" }],
+    ["meta", { property: "og:title", content: "Welcome to our Docs | zkSync Era" }],
+    [
+      "meta",
+      {
+        name: "og:description",
+        content: "zkSync Era is a user-centric zk rollup platform from Matter Labs. It is a scaling solution for Ethereum, already live on Ethereum mainnet.",
+      },
+    ],
 
+    ["meta", { name: "twitter:card", content: "summary" }],
+    ["meta", { name: "twitter:title", content: "Welcome to our Docs | zkSync Era" }],
+    [
+      "meta",
+      {
+        name: "twitter:description",
+        content: "zkSync Era is a user-centric zk rollup platform from Matter Labs. It is a scaling solution for Ethereum, already live on Ethereum mainnet.",
+      },
+    ],
+    ["meta", { name: "twitter:image", content: "https://era.zksync.io/docs/share_image.png" }],
+    ["meta", { name: "twitter:site", content: "@zksync" }],
+    ["meta", { name: "twitter:creator", content: "@the_matter_labs" }],
+    ["meta", { name: "twitter:image:alt", content: "zkSync — Accelerating the mass adoption of crypto for personal sovereignty" }],
 
-    ['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/docs/apple-touch-icon.png" }],
-    ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/docs/favicon-32x32.png" }],
-    ['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/docs/favicon-16x16.png" }],
-    ['link', { rel: "manifest", href: "/docs/site.webmanifest" }],
-    ['link', { rel: "mask-icon", href: "/docs/safari-pinned-tab.svg", color: "#1E69FF" }],
-    ['link', { rel: "shortcut icon", href: "/docs/favicon.ico" }],
-    ['meta', { name: "msapplication-TileColor", content: "#1E69FF" }],
-    ['meta', { name: "msapplication-config", content: "/docs/browserconfig.xml" }],
-    ['meta', { name: "theme-color", content: "#1E69FF" }],
+    ["link", { rel: "apple-touch-icon", sizes: "180x180", href: "/docs/apple-touch-icon.png" }],
+    ["link", { rel: "icon", type: "image/png", sizes: "32x32", href: "/docs/favicon-32x32.png" }],
+    ["link", { rel: "icon", type: "image/png", sizes: "16x16", href: "/docs/favicon-16x16.png" }],
+    ["link", { rel: "manifest", href: "/docs/site.webmanifest" }],
+    ["link", { rel: "mask-icon", href: "/docs/safari-pinned-tab.svg", color: "#1E69FF" }],
+    ["link", { rel: "shortcut icon", href: "/docs/favicon.ico" }],
+    ["meta", { name: "msapplication-TileColor", content: "#1E69FF" }],
+    ["meta", { name: "msapplication-config", content: "/docs/browserconfig.xml" }],
+    ["meta", { name: "theme-color", content: "#1E69FF" }],
 
     [
       "script",
@@ -85,13 +102,12 @@ export default defineUserConfig({
       `,
     ],
   ],
-
 
   theme,
 
   plugins: [
     pwaPlugin({
-      update: "force"
+      update: "force",
     }),
     docsearchPlugin({
       appId: "LCWOUB1OFO",
@@ -113,10 +129,10 @@ export default defineUserConfig({
       template: {
         compilerOptions: {
           // i am ignorning my custom '<container>' tag
-          isCustomElement: (tag) => ['ParentLayout'].includes(tag)
-        }
-      }
-    })
+          isCustomElement: (tag) => ["ParentLayout"].includes(tag),
+        },
+      },
+    }),
   ],
 
   shouldPrefetch: false,

diff --git a/docs/.vuepress/sidebar/en.ts b/docs/.vuepress/sidebar/en.ts
@@ -10,29 +10,32 @@ export const enSidebar = sidebar({
     {
       text: "Getting started",
       link: "/dev/building-on-zksync/hello-world.md", 
-      children: [ "/dev/building-on-zksync/hello-world.md", 
-                  "/dev/building-on-zksync/interacting.md",
-                  "/dev/building-on-zksync/best-practices.md",
-                  "/dev/building-on-zksync/useful-address.md", ],
+      children: [ 
+        "/dev/building-on-zksync/hello-world.md", 
+        "/dev/building-on-zksync/interacting.md",
+        "/dev/building-on-zksync/best-practices.md",
+        "/dev/building-on-zksync/useful-address.md", ],
     },
     {
       text: "How to",
       link: "/dev/how-to/estimate-gas.md",
-      children: [ "/dev/how-to/estimate-gas.md", 
-                  "/dev/how-to/send-transaction-l1-l2",
-                  "/dev/how-to/send-message-l2-l1",
-                  "/dev/how-to/transfer-token-l2",
-                  "/dev/how-to/verify-contracts" ],
+      children: [
+        "/dev/how-to/estimate-gas.md",
+        "/dev/how-to/send-transaction-l1-l2",
+        "/dev/how-to/send-message-l2-l1",
+        "/dev/how-to/transfer-token-l2",
+        "/dev/how-to/verify-contracts",
+      ],
     },
     {
       text: "Tutorials",
       link: "/dev/tutorials/cross-chain-tutorial.md",
-      children: [    
-                "/dev/tutorials/cross-chain-tutorial.md",      
-                "/dev/tutorials/custom-aa-tutorial.md",
-                "/dev/tutorials/aa-daily-spend-limit.md",
-                "/dev/tutorials/custom-paymaster-tutorial.md",
-                "/dev/tutorials/api3-usd-paymaster-tutorial.md",
+      children: [
+        "/dev/tutorials/cross-chain-tutorial.md",
+        "/dev/tutorials/custom-aa-tutorial.md",
+        "/dev/tutorials/aa-daily-spend-limit.md",
+        "/dev/tutorials/custom-paymaster-tutorial.md",
+        "/dev/tutorials/api3-usd-paymaster-tutorial.md",
       ],
     },
   ],
@@ -45,29 +48,23 @@ export const enSidebar = sidebar({
       text: "Concepts",
       link: "/reference/concepts/rollups.md",
       children: [
-        "/reference/concepts/rollups.md", 
-        "/reference/concepts/zkSync.md", 
+        "/reference/concepts/rollups.md",
+        "/reference/concepts/zkSync.md",
         "/reference/concepts/hyperscaling.md",
         {
           text: "Transactions", // required
           link: "/reference/concepts/transactions/transactions.md",
           collapsible: true,
-          children: [
-            "/reference/concepts/transactions/transactions.md",
-            "/reference/concepts/transactions/blocks.md",
-            "/reference/concepts/transactions/fee-model.md",]
+          children: ["/reference/concepts/transactions/transactions.md", "/reference/concepts/transactions/blocks.md", "/reference/concepts/transactions/fee-model.md"],
         },
         "/reference/concepts/finality.md",
-        "/reference/concepts/aa.md",     
+        "/reference/concepts/aa.md",
         {
           text: "Bridging", // required
           link: "/reference/concepts/bridging/bridging-asset.md",
           collapsible: true,
-          children: [
-            "/reference/concepts/bridging/bridging-asset.md",
-            "/reference/concepts/bridging/l1-l2-interop.md",]
+          children: ["/reference/concepts/bridging/bridging-asset.md", "/reference/concepts/bridging/l1-l2-interop.md"],
         },
-        "/reference/concepts/videos.md",
       ],
     },
     {
@@ -82,26 +79,25 @@ export const enSidebar = sidebar({
           children: [
             "/reference/architecture/contracts/contract-development.md",
             "/reference/architecture/contracts/contract-deployment.md",
-            "/reference/architecture/contracts/system-contracts.md", ]
+            "/reference/architecture/contracts/system-contracts.md",
+          ],
         },
         "/reference/architecture/events.md",
       ],
     },
     {
       text: "Troubleshooting",
-      link: "/reference/troubleshooting/important-links.md",
+      link: "/reference/troubleshooting/README.md",
       children: [
-        "/reference/troubleshooting/important-links.md",
         "/reference/troubleshooting/changelog.md",
         "/reference/troubleshooting/withdrawal-delay.md",
         "/reference/troubleshooting/audit-bug-bounty.md",
         "/reference/troubleshooting/docs-contribution/docs.md",
-        "/reference/troubleshooting/docs-contribution/community-resources.md",
         "/reference/troubleshooting/faq.md",
       ],
     },
   ],
-    //The sidebar for Tools and SDKs
+  //The sidebar for Tools and SDKs
   "/api": [
     {
       text: "Web3 JSON-RPC API", // required
@@ -138,14 +134,7 @@ export const enSidebar = sidebar({
     {
       text: "Go SDK",
       link: "/api/go",
-      children: [
-        "/api/go/getting-started",
-        "/api/go/providers",
-        "/api/go/accounts",
-        "/api/go/accounts-l1-l2",
-        "/api/go/contract-interface",
-        "/api/go/types",
-      ],
+      children: ["/api/go/getting-started", "/api/go/providers", "/api/go/accounts", "/api/go/accounts-l1-l2", "/api/go/contract-interface", "/api/go/types"],
     },
     {
       text: "Java SDK", // required
@@ -192,9 +181,7 @@ export const enSidebar = sidebar({
     {
       text: "Block Explorer and Tools", // required
       link: "/tools/block-explorer", // optional, which should be a absolute path.
-      children: [ "/tools/block-explorer/block-explorer-menu", 
-                  "/tools/block-explorer/contract-verification",
-                  ],
+      children: ["/tools/block-explorer/block-explorer-menu", "/tools/block-explorer/contract-verification"],
     },
   ],
 });