docs: update layout and structure (#916)

* docs: update layout and structure * update titles and content * consolidate validator docs * consolidate validator docs * update interfaces link
regen-network · Mar 22, 2022 · 07371fb · 07371fb
1 parent 869defa
commit 07371fb
Show file tree

Hide file tree

Showing 29 changed files with 404 additions and 477 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Regen Ledger
 
-![banner](docs/regen_ledger.png)
+![banner](docs/.vuepress/public/regen-ledger.png)
 
 [![Build status](https://github.com/regen-network/regen-ledger/workflows/Build/badge.svg)](https://github.com/regen-network/regen-ledger/commits/master)
 [![Tests status](https://github.com/regen-network/regen-ledger/workflows/Tests/badge.svg)](https://github.com/regen-network/regen-ledger/commits/master)

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -17,7 +17,6 @@ module.exports = {
    * Ref：https://v1.vuepress.vuejs.org/config/#description
    */
   description: description,
-
   /**
    * Extra tags to be injected to the page HTML `<head>`
    *
@@ -38,7 +37,7 @@ module.exports = {
       {
         async: true,
         src: 'https://www.googletagmanager.com/gtag/js?id=' + process.env.GOOGLE_ANALYTICS_ID,
-      }
+      },
     ],
     [
       'script',
@@ -56,136 +55,159 @@ module.exports = {
    */
   themeConfig: {
     repo: 'regen-network/regen-ledger',
-    editLinks: false,
     docsDir: 'docs',
-    lastUpdated: false,
     nav: [
       {
-        text: 'Getting Started',
-        link: '/getting-started/',
-      }
+        text: 'Regen Ledger',
+        link: '/ledger/',
+      },
+      {
+        text: 'Modules',
+        link: '/modules/',
+      },
+      {
+        text: 'Validators',
+        link: '/validators/',
+      },
+      {
+        text: 'Commands',
+        link: '/commands/',
+      },
+      {
+        text: 'Tutorials',
+        link: '/tutorials/',
+      },
     ],
     sidebar: {
-      '/': [
+      '/ledger/': [
         {
           title: 'Introduction',
           collapsable: false,
           children: [
-            '/intro/',
-          ]
+            '/ledger/',
+          ],
         },
         {
-          title: 'Getting Started',
+          title: 'Get Started',
           collapsable: false,
           children: [
-            '/getting-started/',
-            '/getting-started/live-networks',
-            '/getting-started/running-a-full-node',
-            '/getting-started/running-a-validator',
-            '/getting-started/prerequisites'
-          ]
+            '/ledger/get-started/',
+            '/ledger/get-started/live-networks',
+            '/ledger/get-started/prerequisites',
+          ],
         },
         {
-          title: 'Migrations',
+          title: 'Infrastructure',
           collapsable: false,
           children: [
-            '/migrations/upgrade',
-            '/migrations/v2.0-upgrade',
-            '/migrations/v3.0-upgrade',
-          ]
+            '/ledger/infrastructure/',
+            '/ledger/infrastructure/interfaces',
+          ],
         },
+      ],
+      '/modules/': [
         {
-          title: 'Regen Ledger',
+          title: 'Modules',
           collapsable: false,
+          sidebarDepth: 0,
           children: [
-            '/regen-ledger/',
-            '/regen-ledger/interfaces',
-          ]
+            {
+              title: 'List of Modules',
+              path: '/modules/',
+            },
+          ],
         },
         {
-          title: 'Modules',
+          title: 'Ecocredit Module',
           collapsable: false,
           children: [
             {
-              title: 'Ecocredit Module',
-              collapsable: false,
-              children: [
-                {
-                  title: 'Overview',
-                  path: '/modules/ecocredit/'
-                },
-                '/modules/ecocredit/01_concepts',
-                '/modules/ecocredit/02_state',
-                '/modules/ecocredit/03_messages',
-                '/modules/ecocredit/04_events',
-                '/modules/ecocredit/05_client',
-                {
-                  title: 'Protobuf - Core',
-                  path: 'https://buf.build/regen/regen-ledger/docs/main/regen.ecocredit.v1'
-                },
-                {
-                  title: 'Protobuf - Basket',
-                  path: 'https://buf.build/regen/regen-ledger/docs/main/regen.ecocredit.basket.v1'
-                },
-                {
-                  title: 'Protobuf - Marketplace',
-                  path: 'https://buf.build/regen/regen-ledger/docs/main/regen.ecocredit.marketplace.v1'
-                }
-              ]
+              title: 'Overview',
+              path: '/modules/ecocredit/',
             },
+            '/modules/ecocredit/01_concepts',
+            '/modules/ecocredit/02_state',
+            '/modules/ecocredit/03_messages',
+            '/modules/ecocredit/04_events',
+            '/modules/ecocredit/05_client',
             {
-              title: 'Data Module',
-              collapsable: false,
-              children: [
-                {
-                  title: 'Overview',
-                  path: '/modules/data/'
-                },
-                '/modules/data/01_concepts',
-                '/modules/data/02_state',
-                '/modules/data/03_messages',
-                '/modules/data/04_events',
-                '/modules/data/05_client',
-                {
-                  title: 'Protobuf',
-                  path: 'https://buf.build/regen/regen-ledger/docs/main/regen.data.v1'
-                }
-              ]
+              title: 'Protobuf - Core',
+              path: 'https://buf.build/regen/regen-ledger/docs/main/regen.ecocredit.v1',
             },
             {
-              title: 'Group Module',
-              collapsable: false,
-              children: [
-                {
-                  title: 'Overview',
-                  path: '/modules/group/'
-                },
-                '/modules/group/01_concepts',
-                '/modules/group/02_state',
-                '/modules/group/03_messages',
-                '/modules/group/04_events',
-                // '/modules/group/05_client',
-                {
-                  title: 'Protobuf',
-                  path: 'https://buf.build/regen/regen-ledger/docs/main/regen.group.v1alpha1'
-                }
-              ]
+              title: 'Protobuf - Basket',
+              path: 'https://buf.build/regen/regen-ledger/docs/main/regen.ecocredit.basket.v1',
             },
-          ]
+            {
+              title: 'Protobuf - Marketplace',
+              path: 'https://buf.build/regen/regen-ledger/docs/main/regen.ecocredit.marketplace.v1',
+            },
+          ],
         },
         {
-          title: 'Tutorials',
+          title: 'Data Module',
+          collapsable: false,
+          children: [
+            {
+              title: 'Overview',
+              path: '/modules/data/',
+            },
+            '/modules/data/01_concepts',
+            '/modules/data/02_state',
+            '/modules/data/03_messages',
+            '/modules/data/04_events',
+            '/modules/data/05_client',
+            {
+              title: 'Protobuf',
+              path: 'https://buf.build/regen/regen-ledger/docs/main/regen.data.v1',
+            },
+          ],
+        },
+      ],
+      '/validators/': [
+        {
+          title: 'Validators',
+          collapsable: false,
+          children: [
+            {
+              title: 'Overview',
+              path: '/validators/',
+            },
+          ],
+        },
+        {
+          title: 'Get Started',
           collapsable: false,
           children: [
-            '/tutorials/',
-            // '/tutorials/data-cli',
-            // '/tutorials/data-grpc',
-            '/tutorials/ibc-transfers'
+            '/validators/get-started/run-a-full-node',
+            '/validators/get-started/create-a-validator',
+            '/validators/get-started/prerequisites',
           ]
         },
+        {
+          title: 'Migrations',
+          collapsable: false,
+          children: [
+            '/validators/migrations/upgrade',
+            '/validators/migrations/v2.0-upgrade',
+            '/validators/migrations/v3.0-upgrade',
+          ],
+        },
+      ],
+      '/commands/': [
         {
           title: 'Commands',
           collapsable: false,
+          children: [
+            {
+              title: 'List of Commands',
+              path: '/commands/',
+            },
+          ],
+        },
+        {
+          title: 'Regen App',
+          collapsable: false,
           sidebarDepth: 0,
           children: [
               '/commands/regen',
@@ -211,7 +233,32 @@ module.exports = {
           ]
         },
       ],
-    }
+      '/tutorials/': [
+        {
+          title: 'Tutorials',
+          collapsable: false,
+          sidebarDepth: 0,
+          children: [
+            {
+              title: 'List of Tutorials',
+              path: '/tutorials/',
+            },
+          ],
+        },
+        {
+          title: 'User Tutorials',
+          collapsable: false,
+          children: [
+            '/tutorials/ibc-transfers',
+          ],
+        },
+        {
+          title: 'Developer Tutorials',
+          collapsable: false,
+          children: [],
+        },
+      ],
+    },
   },
   /**
    * Apply plugins，ref：https://v1.vuepress.vuejs.org/plugin/

diff --git a/docs/regen_ledger.png → docs/.vuepress/public/regen-ledger.png b/docs/regen_ledger.png → docs/.vuepress/public/regen-ledger.png
diff --git a/docs/.vuepress/public/regen-logo.png b/docs/.vuepress/public/regen-logo.png
diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl
@@ -4,5 +4,35 @@
  * ref：https://v1.vuepress.vuejs.org/config/#index-styl
  */
 
+@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,100;0,300;0,400;0,700;0,900;1,100;1,300;1,400;1,700;1,900&display=swap');
+
+body
+  font-family 'Lato', sans-serif;
+  font-size 1.05em
+
+h1, h2, h3, h4, h5, h6
+  font-weight 600 !important
+
+.site-name
+  font-weight 400 !important
+  font-size 1.05em !important
+
 .home .hero img
-  max-width 450px!important
+  max-height 350px !important
+  object-fit cover
+  width 100%
+
+#main-title
+  display none
+
+.navbar
+  background #FDFDFD
+
+.navbar .links
+  background #FDFDFD !important
+
+.sidebar
+  background #FDFDFD
+
+.content__default
+  padding-top 5% !important
diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl
@@ -5,6 +5,6 @@
  */
 
 $accentColor = #3eaf7c
-$textColor = #2c3e50
+$textColor = #3B454E
 $borderColor = #eaecef
 $codeBgColor = #282c34
diff --git a/docs/COMMANDS.md b/docs/COMMANDS.md
@@ -0,0 +1,24 @@
+# Commands
+
+The following commands are available using the `regen` binary. The documentation for each command is auto-generated from the help text.
+
+- [regen](/commands/regen)
+- [regen add-genesis-account](/commands/regen_add-genesis-account)
+- [regen collect-gentxs](/commands/regen_collect-gentxs)
+- [regen config](/commands/regen_config)
+- [regen debug](/commands/regen_debug)
+- [regen export](/commands/regen_export)
+- [regen gentx](/commands/regen_gentx)
+- [regen init](/commands/regen_init)
+- [regen keys](/commands/regen_keys)
+- [regen migrate](/commands/regen_migrate)
+- [regen query](/commands/regen_query)
+- [regen rosetta](/commands/regen_rosetta)
+- [regen start](/commands/regen_start)
+- [regen status](/commands/regen_status)
+- [regen tendermint](/commands/regen_tendermint)
+- [regen testnet](/commands/regen_testnet)
+- [regen tx](/commands/regen_tx)
+- [regen unsafe](/commands/regen_unsafe-reset-all)
+- [regen validate](/commands/regen_validate-genesis)
+- [regen version](/commands/regen_version)