Docs config (#605)

* bump 1.0.167

* code blocks sh → bash

* update color variables

* clean up sidebar, add footer

* sh → bash

* tweak kava logo.svg

* bump 1.0.168

* update sidebar, footer

Co-authored-by: denalimarsh <denalimarsh@gmail.com>

README.md

@@ -29,7 +29,7 @@ Note, the current recommended version of the software for mainnet is v0.8.1. The
 
 ### Installation
 
-```sh
+```bash
 git checkout v0.8.1
 make install
 ```

contrib/kava-3/migration.md

@@ -48,7 +48,7 @@ In the event that the upgrade does not succeed, validators and operators must do
 
 Set your node to produce the final block of kava-2 at __13:00__ UTC June 10th, 2020. To restart your node with that stop time,
 
-```sh
+```bash
 kvd start --halt-time 1591794000
 ```
 
@@ -70,13 +70,13 @@ The following up steps assume the directory structure below: change filepaths, d
 ### Pre-Migration
 
 1. Backup existing kava-2 .kvd and .kvcli
-```sh
+```bash
 cp -R ~/.kvcli ~/.kvcli.bak
 cp -R ~/.kvd ~/.kvd.bak
 ```
 
 2. Backup existing kava-2 kvd and kvcli binaries (in case of rollback)
-```sh
+```bash
 cp ~/go/bin/kvcli ~/go/bin/kvcli.bak
 cp ~/go/bin/kvd ~/go/bin/kvd.bak
 ```
@@ -89,7 +89,7 @@ We denote `(kava-2)kvd` as the previous client (0.3.5) to be used for commands e
 
 - Ensure that all `kvd` processes have stopped running.
 
-```sh
+```bash
   (kava-2) kvd export --height 2598890 --for-zero-height > kava_2_exported.json
   # Check ShaSum for later reference
   $ jq -S -c -M '' kava_2_exported.json | shasum -a 256
@@ -101,7 +101,7 @@ We denote `(kava-2)kvd` as the previous client (0.3.5) to be used for commands e
 
 This will replace the `kvd` and `kvcli` binaries in your GOPATH.
 
-```sh
+```bash
   # in the `kava` folder
   git pull
   git checkout v0.8.1
@@ -122,14 +122,14 @@ This will replace the `kvd` and `kvcli` binaries in your GOPATH.
 
 This will scan for any keys in `.kvcli` and produce new files ending in `kavaxxx.address` and `key_name.info` for the new keystore to access.
 
-```sh
+```bash
   # Migrate keys
   (kava-3) kvcli keys migrate
 ```
 
 4. Migrate the exported genesis state
 
-```sh
+```bash
   # Migrate genesis state
   (kava-3) kvd migrate kava_2_exported.json > kava_3_migrated.json
   # Check ShaSum for later reference
@@ -140,7 +140,7 @@ This will scan for any keys in `.kvcli` and produce new files ending in `kavaxxx
 
 5. Write Params to genesis state and validate
 
-```sh
+```bash
   # Migrate parameters
   (kava-3) kvd write-params kava_3_migrated.json --chain-id kava-3 --genesis-time 2020-06-10T14:00:00Z > genesis.json
   # Check ShaSum for later reference
@@ -155,7 +155,7 @@ This will scan for any keys in `.kvcli` and produce new files ending in `kavaxxx
 
 6. Restart node with new kava-3 genesis state
 
-```sh
+```bash
   cp genesis.json ~/.kvd/config/genesis.json
   # Unsafe Reset All is a irreversible action that wipes on-chain data and prepares the chain for a start from genesis
   # If you have not backed up your previous kava-2 state, do not proceed.

docs/.vuepress/config.js

@@ -3,11 +3,22 @@ module.exports = {
   title: "Kava Documentation",
   themeConfig: {
     logo: {
-      src: "/kava-logo.svg",
+      src: "/logo.svg",
     },
     custom: true,
-    autoSidebar: true,
+    sidebar: {
-    sidebar: [
+      auto: false,
+      nav: [
+        {
+          title: "Reference",
+          children: [
+            {
+              title: "Modules",
+              path: "/Modules",
+              directory: true
+            },
+          ]
+        },
         {
           title: "Kava Tools",
           children: [
@@ -46,28 +57,81 @@ module.exports = {
               path: "https://pkg.go.dev/github.com/kava-labs/kava?tab=subdirectories"
             }
           ]
+        }
+      ]
     },
+    footer: {
+      logo: "/logo.svg",
+      textLink: {
+        text: "kava.io",
+        url: "https://www.kava.io"
+      },
+      services: [
+        {
+          service: "twitter",
+          url: "https://twitter.com/kava_labs"
+        },
+        {
+          service: "medium",
+          url: "https://medium.com/kava-labs"
+        },
+        {
+          service: "telegram",
+          url: "https://t.me/kavalabs"
+        },
+        {
+          service: "discord",
+          url: "https://discord.com/invite/kQzh3Uv"
+        },
+        {
+          service: "github",
+          url: "https://github.com/kava-labs"
+        }
+      ],
+      smallprint:
+        `© ${new Date().getFullYear()} Kava Labs.`,
+      links: [
         {
           title: "Community",
           children: [
             {
-            title: "Twitter",
+              title: "Blog",
-            path: "https://twitter.com/kava_labs"
+              url: "https://medium.com/kava-labs"
             },
             {
-            title: "Telegram",
+              title: "Chat",
-            path: "https://t.me/kavalabs"
+              url: "https://t.me/kavalabs"
-          },
-          {
-            title: "Discord",
-            path: "https://discord.com/channels/704389840614981673/704389841051320362"
-          },
-          {
-            title: "GitHub",
-            path: "https://github.com/Kava-Labs/kava"
             }
           ]
+        },
+        {
+          title: "Contributing",
+          children: [
+            {
+              title: "Contributing to the docs",
+              url:
+                "https://github.com/Kava-Labs/kava/tree/master/docs"
+            },
+            {
+              title: "Source code on GitHub",
+              url: "https://github.com/Kava-Labs/kava"
             }
           ]
+        },
+        {
+          title: "Related Docs",
+          children: [
+            {
+              title: "Cosmos SDK",
+              url: "https://cosmos.network/docs"
+            },
+            {
+              title: "Binance Chain",
+              url: "https://docs.binance.org"
+            }
+          ]
+        },
+      ]
+    }
   }
 };

docs/.vuepress/public/kava-logo.svg

@@ -1,21 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 24.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 1186 360" style="enable-background:new 0 0 1186 360;" xml:space="preserve">
-<style type="text/css">
-	.st0{fill:#FF564F;}
-</style>
-<g>
-	<polygon class="st0" points="843.7,63.3 909.9,63.3 794.7,349.6 718.2,349.6 603,63.3 669.2,63.3 756.3,280.6 	"/>
-	<rect x="9" y="4.1" class="st0" width="60.3" height="345.6"/>
-	<polygon class="st0" points="234.2,349.7 102.1,176.9 234.2,4.1 309.9,4.1 179.5,176.9 309.9,349.7 	"/>
-	<path class="st0" d="M454.2,55.7c-66,0-115.7,36.5-119.3,90.8l-0.4,6.4h59.2l1-4.7c5.5-25.5,26.3-39.5,58.5-39.5
-		c35,0,55.1,17.6,55.1,48.4v17.7L434,179c-66.8,3.9-107.2,36.6-107.2,87.4c0,53.6,40.2,89.5,99.3,89.5c35.2,0,60.9-9.6,81.9-31.1
-		V351h60V152.5C568,93.7,522.6,55.7,454.2,55.7z M508.2,221.2V239c-3.9,38.9-30.8,63.3-72,65.3c-15.9,0.8-29.6-3.5-38.6-12.1
-		c-7.1-6.7-10.8-15.7-10.8-25.9c0-22.8,19.4-37.1,53.5-39.3L508.2,221.2z"/>
-	<path class="st0" d="M1063.2,55.7c-66,0-115.7,36.5-119.3,90.8l-0.4,6.4h59.2l1-4.7c5.5-25.5,26.3-39.5,58.5-39.5
-		c35,0,55.1,17.6,55.1,48.4v17.7l-74.2,4.2c-66.8,3.9-107.2,36.6-107.2,87.4c0,53.6,40.2,89.5,99.3,89.5c35.2,0,60.9-9.6,81.9-31.1
-		V351h60V152.5C1177,93.7,1131.6,55.7,1063.2,55.7z M1117.3,221.2V239c-3.9,38.9-30.8,63.3-72,65.3c-15.9,0.8-29.6-3.5-38.6-12.1
-		c-7.1-6.7-10.8-15.7-10.8-25.9c0-22.8,19.4-37.1,53.5-39.3L1117.3,221.2z"/>
-</g>
-</svg>

docs/.vuepress/public/logo.svg

@@ -0,0 +1,7 @@
+<svg width="160" height="48" viewBox="0 0 160 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M114.333 8.07732H123.4L107.621 47.1404H97.1424L81.3629 8.07732H90.4306L102.361 37.726L114.333 8.07732Z" fill="#FF564F"/>
+<path d="M8.25957 0H0V47.1541H8.25957V0Z" fill="#FF564F"/>
+<path d="M30.8467 47.1541L12.7523 23.577L30.8467 0H41.2157L23.3542 23.577L41.2157 47.1541H30.8467Z" fill="#FF564F"/>
+<path d="M60.9811 7.04036C51.9408 7.04036 45.1331 12.0205 44.64 19.4292L44.5852 20.3024H52.6941L52.8311 19.6612C53.5845 16.1819 56.4335 14.2717 60.8441 14.2717C65.6382 14.2717 68.3914 16.6731 68.3914 20.8755V23.2905L58.2142 23.8636C49.0643 24.3957 43.5305 28.8573 43.5305 35.7885C43.5305 43.1018 49.0369 48 57.1321 48C61.9536 48 65.4738 46.6902 68.3503 43.7567V47.3314H76.5688V20.2479C76.5688 12.2251 70.3501 7.04036 60.9811 7.04036ZM68.3777 29.6214V32.05C67.8435 37.3576 64.1589 40.6868 58.5155 40.9596C56.3376 41.0688 54.4611 40.4821 53.2283 39.3087C52.2558 38.3945 51.749 37.1666 51.749 35.7749C51.749 32.664 54.4063 30.7129 59.0771 30.4127L68.3777 29.6214Z" fill="#FF564F"/>
+<path d="M144.399 7.04036C135.358 7.04036 128.551 12.0205 128.058 19.4292L128.003 20.3024H136.112L136.249 19.6612C137.002 16.1819 139.851 14.2717 144.262 14.2717C149.056 14.2717 151.809 16.6731 151.809 20.8755V23.2905L141.645 23.8636C132.496 24.3957 126.962 28.8573 126.962 35.7885C126.962 43.1018 132.468 48 140.563 48C145.385 48 148.905 46.6902 151.782 43.7567V47.3314H160V20.2479C159.986 12.2251 153.768 7.04036 144.399 7.04036ZM151.809 29.6214V32.05C151.275 37.3576 147.59 40.6868 141.947 40.9596C139.769 41.0688 137.892 40.4821 136.66 39.3087C135.687 38.3945 135.18 37.1666 135.18 35.7749C135.18 32.664 137.838 30.7129 142.508 30.4127L151.809 29.6214Z" fill="#FF564F"/>
+</svg>

docs/.vuepress/styles/index.styl

@@ -1,4 +1,3 @@
 :root
-  --accent-color #ff554f
+  --color-link #ff554f
-  --background #161931
+  --color-primary #ff554f
-  --ds-color-primary #ff554f

docs/package.json

@@ -15,7 +15,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "vuepress-theme-cosmos": "^1.0.166"
+    "vuepress-theme-cosmos": "^1.0.168"
   },
   "devDependencies": {
     "watchpack": "^1.6.1"

docs/readme.md

@@ -1,3 +1,11 @@
+---
+title: Kava Documentation
+description: The documentation of Kava.
+footer:
+  newsletter: false
+aside: true
+---
+
 # Kava
 
 ## DeFi for Crypto.
@@ -10,7 +18,7 @@ The current recommended version of the software for mainnet is [v0.8.1](https://
 
 ### Installation
 
-```sh
+```bash
 git checkout v0.8.1
 make install
 ```