chore(docs): implement docs design

quasystaty1 · Apr 9, 2024 · 49c5ad5 · 49c5ad5
1 parent 860c3c6
commit 49c5ad5
Show file tree

Hide file tree

Showing 6 changed files with 577 additions and 253 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -9,7 +9,6 @@ export default defineConfig({
   cleanUrls: true,
   ignoreDeadLinks: true,
   base: base,
-
   themeConfig: {
     editLink: {
       pattern: "https://github.com/astriaorg/docs/edit/main/docs/:path",
@@ -19,10 +18,7 @@ export default defineConfig({
     logo: { src: '/astria-logo-mini.svg', width: 24, height: 24 },
 
     // https://vitepress.dev/reference/default-theme-config
-    nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Just Rollup', link: '/local-rollup/1-introduction' }
-    ],
+    nav: nav(),
 
     search: {
       provider: "local",
@@ -31,79 +27,98 @@ export default defineConfig({
       },
     },
 
-    sidebar: [
-      {
-
-        items: [
-          {
-            text: 'What is Astria?',
-            collapsed: true,
-            items: [
-              { text: 'Overview', link: '/overview/1-introduction' },
-              { text: 'Why Decentralized Sequencers?', link: '/overview/2-why-decentralized-sequencers' },
-              { text: 'Cross-Rollup Composability', link: '/overview/3-cross-rollup-composability' },
-
-              {
-                text: 'Architecture',
-                collapsed: true,
-                items: [
-                  { text: 'Overview', link: '/overview/architecture/1-overview' },
-                  { text: 'Transaction Flow', link: '/overview/architecture/2-transaction-flow' },
-                  { text: 'Rollups', link: '/overview/architecture/3-rollup' },
-                  { text: 'Composer', link: '/overview/architecture/4-composer' },
-                  { text: 'The Astria Sequencer', link: '/overview/architecture/5-the-astria-sequencer' },
-                  { text: 'Relayer', link: '/overview/architecture/6-relayer' },
-                  { text: 'Conductor', link: '/overview/architecture/7-conductor' },
-                  { text: 'Data Availability Layer', link: '/overview/architecture/8-data-availability-layer' },
-                ]
-              },
-            ]
-          }
-        ],
-      },
-      {
-        text: 'Developers',
-        collapsed: true,
-        items: [
-          {
-            text: 'Tutorials',
-            collapsed: true,
-            items: [
-              { text: 'Deploy a Local Rollup', link: '/local-rollup/1-introduction' },
-              {
-                text: 'Deploy a Cloud Rollup',
-                collapsed: true,
-                items: [
-                  { text: 'Digital Ocean', link: '/cloud-rollup/digital-ocean' },
-                ]
-              },
-              { text: 'Using the astria cli', link: '/developer/tutorials/1-using-astria-go-cli.md' },
-
-            ]
-          },
-          {
-            text: 'The Astria EVM', link: '/astria-evm/overview'
-          },
-        ]
-      },
-      {
-        text: 'Resources',
-        collapsed: true,
-        items: [
-          {
-            text: 'Community',
-            collapsed: true,
-            items: [
-              { text: 'Overview', link: '/community/1-overview' }
-            ]
-          },
-          { text: 'Dusknet FAQ', link: '/dusk-faq/1-information' }
-        ]
-      }
-    ],
+    sidebar: sidebar(),
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/astriaorg/astria' }
-    ]
+      { icon: "github", link: "https://github.com/astriaorg" },
+      { icon: "twitter", link: "https://twitter.com/AstriaOrg" },
+    ],
   }
 })
+
+function sidebar() {
+  return [
+    {
+
+      items: [
+        {
+          text: 'What is Astria?',
+          collapsed: true,
+          items: [
+            { text: 'Overview', link: '/overview/1-introduction' },
+            { text: 'Why Decentralized Sequencers?', link: '/overview/2-why-decentralized-sequencers' },
+            { text: 'Cross-Rollup Composability', link: '/overview/3-cross-rollup-composability' },
+
+            {
+              text: 'Architecture',
+              collapsed: true,
+              items: [
+                { text: 'Overview', link: '/overview/architecture/1-overview' },
+                { text: 'Transaction Flow', link: '/overview/architecture/2-transaction-flow' },
+                { text: 'Rollups', link: '/overview/architecture/3-rollup' },
+                { text: 'Composer', link: '/overview/architecture/4-composer' },
+                { text: 'The Astria Sequencer', link: '/overview/architecture/5-the-astria-sequencer' },
+                { text: 'Relayer', link: '/overview/architecture/6-relayer' },
+                { text: 'Conductor', link: '/overview/architecture/7-conductor' },
+                { text: 'Data Availability Layer', link: '/overview/architecture/8-data-availability-layer' },
+              ]
+            },
+          ]
+        }
+      ],
+    },
+    {
+      text: 'Developers',
+      collapsed: true,
+      items: [
+        {
+          text: 'Tutorials',
+          collapsed: true,
+          items: [
+            { text: 'Deploy a Local Rollup', link: '/local-rollup/1-introduction' },
+            {
+              text: 'Deploy a Cloud Rollup',
+              collapsed: true,
+              items: [
+                { text: 'Digital Ocean', link: '/cloud-rollup/digital-ocean' },
+              ]
+            },
+            { text: 'Using the astria cli', link: '/developer/tutorials/1-using-astria-go-cli.md' },
+
+          ]
+        },
+        {
+          text: 'The Astria EVM', link: '/astria-evm/overview'
+        },
+      ]
+    },
+    {
+      text: 'Resources',
+      collapsed: true,
+      items: [
+        {
+          text: 'Community',
+          collapsed: true,
+          items: [
+            { text: 'Overview', link: '/community/1-overview' }
+          ]
+        },
+        { text: 'Dusknet FAQ', link: '/dusk-faq/1-information' }
+      ]
+    }
+  ]
+}
+
+function nav() {
+  return [
+    { text: 'Home', link: '/' },
+    {
+      text: "Join the network",
+      items: [
+        { text: "Learn", link: "/overview/1-introduction" },
+        { text: "Developers", link: "/local-rollup/1-introduction" },
+        { text: "Community", link: '/community/1-overview' },
+      ],
+    },
+  ];
+}