Merge official documentation to main (#688)

* First version of Osmosis docs site. Work in progress.

* Updated docs build branch trigger to the doc branch in order to test it. Once this is ready it will be changed back to the main branch.

* Updated Doc Git Action's title

* Joining Testnet Github Pages (#605)

* Czar docs for PR to docs/dev
* test
* Added joining testnet instructions

* Joining Mainnet Github Pages (#606)

* Czar docs for PR to docs/dev
* test
* Added joining testnet instructions
* Joining mainnet instructions completed with minor testnet changes

* New sidebar structure
Breakdown of joining testnet/mainnet
Separated instructions for installing CLI
Added new integration's section with the token listing process
Created new terminology page
Removed other-features, moved LBPs into the liquidity section
Created a new wallet's section place holder.

* Added home page, navbar, osmo theme color, and squared out logo (#607) (#608)

* Czar docs for PR to docs/dev

* test

* Added joining testnet instructions

* Joining mainnet instructions completed with minor testnet changes

* added home page, navbar, osmo theme color, and squared out logo

Co-authored-by: Daniel Farina <[email protected]>

Co-authored-by: Adam Tucker <[email protected]>
Co-authored-by: Daniel Farina <[email protected]>

* New theme
New stylesheet overwrite
New config Typescript based
Added app screenshot on intro
Moved a few sections around
Added block explorer links
Updated home page links

* Intro page app screenshot

* Docs dev (#613)

* Updated Doc Git Action's title

* Joining Testnet Github Pages (#605)

* Czar docs for PR to docs/dev
* test
* Added joining testnet instructions

* Joining Mainnet Github Pages (#606)

* Czar docs for PR to docs/dev

* test

* Added joining testnet instructions

* Joining mainnet instructions completed with minor testnet changes

* New sidebar structure

*  Breakdown of joining testnet/mainnet

*  Separated instructions for installing CLI

*  Added new integration's section with the token listing process

*  Created new terminology page

* Removed other-features, moved LBPs into the liquidity section

* Created a new wallet's section place holder.

* Added home page, navbar, osmo theme color, and squared out logo (#607) (#608)

* Czar docs for PR to docs/dev

* test

* Added joining testnet instructions

* Joining mainnet instructions completed with minor testnet changes

* added home page, navbar, osmo theme color, and squared out logo

Co-authored-by: Adam Tucker <[email protected]>
Co-authored-by: Daniel Farina <[email protected]>

* Simplified navigation
Added wallet doc (needs work, place holder)
Added Osmosis App section
Created the Develop/Validate/Integrate folders with unique navigation for each.

* Example of Keplr instructions with screen captures.
Other fixes.

* Adding some screen capture examples to Kepler guide.

* Example of visual instructions.

* Osmosis labs docs (#617)

* create section bookmarks, mainnet/testnet division, homepage simplify
* accidental merge issue

* Docs vue (#622)

* Updated Docs based on VUEPRESS 1.x

* Deleted old files

* Adding discord & Github card
Small padding fix

* added validator instructions, fixed dark mode logo, dark mode card text to black

* Updated integrator & validators doc & nav.

Co-authored-by: Adam Tucker <[email protected]>

* package update

* sidebar fixes

* Add base to site in order for assets to load correctly.

* Image path fix.

* Docs vue (#624)

* Updated Docs based on VUEPRESS 1.x

* Deleted old files

* Adding discord & Github card
Small padding fix

* added validator instructions, fixed dark mode logo, dark mode card text to black

* Updated integrator & validators doc & nav.

* v0.0.2

* added more validator instructions, got rid of inline css and changed class instead

* included smooth scrolling, code clipboard button, included line numbers with line number spacing fix, reduced white in dark mode

* validator sidebar bug fix, must have osmo in wallet paragraph, track validator active set command

* small code cleanup before testing larger change

* night switch changes color, changed palette to exact osmo colors, changed searchbar

* Navbar breakpoint increased, mobile colors corrected, dark mode switch color corrected

* logo padding fix, color adjust

Co-authored-by: Adam Tucker <[email protected]>

* Fix small typo

* Fix small typo

* Merge remote-tracking branch 'origin/docs' into docs-vue

* plugin-resgister-compenents 2.0.0 caused build issues on git pages, moved down to 1.3.1

* absolute image path fix

* relative path img

* img path fix attempt

* img path fixed and button fill issue

* version update to force cache update

* fill issues

* osmo bullets

* mobile fixes

* further mobile fixes

* color correction

* revive dead links

* added testnet instructions using v4 and snapshot

* Deleted sample modules doc's
Created placeholder for Osmosis modules
We will reference all native modules after we document our modules first.

* Updated sidebar - Added new modules, deleted old place holders.

* Added the official gamm module documentation.

* title updates

* title updates

* Added txfees docs

* Added lockup docs

* testnet snapshot link improved

* Added validator home page, removed manual as of dates

* Simplified APP docs structure.

* Integrate and Validate have home pages

* homepage change cards

* created home pages for all tabs but overview, added pictures for network resource cards

* homepage redesign for simplicity

* changed home page

* code background change, icon improvement

* code line height did not match numbering

* v5 testnet instructions

* update package.json version for cache reset

* disable smooth scroll until snap to line is fixed

* changed to v5 rc2

* added gov module, added verticle lines to tables

* no more boring scroll bars

* small gov change

* changed code copy button and plugin

* fixed new snapshot links, added tabs for each type of node

* clarified node instructions, clarified gov module, small grammar errors

* fixed checksum instructions

* add git pull to commands, fixed clipboard text copied

* mint module completed

* added unsafe_skip_backup changes

* added nested tables, making snapshot dl easy. Re enable smoothscroll since fixed

* changed to v5 for cli init

* stuck with wget

* validator instructions were duplicated

* removed prep cosmovisor instructions since upgrade happened

* changed icons, darkened dark mode

* V6 instructions

* combined update of cosmovisor and osmosisd

* added lockup module docs, added module landing page

* changed 4.2.0 to 6.0.0

* added gamm module docs

* module work, standardizing

* gov module token burn rules

* updated testnet mp20 snapshot command

* added incentives module, changed $URL quicksync

* chainlayer's checksum isnt always hosted correctly

* Testing base path for domain config

Changing base path to make docs.osmosis.zone work properly.

* fixed paths for docs.osmosis.zone assets

* meta tag test

* open graph img

* finishing modules, minor updates for soft launch

* dark mode edits

* Finished the OSMOSIS AMM overview
Added keys for Argolia search, still need indexing.

Co-authored-by: Adam Tucker <[email protected]>
Co-authored-by: Daniel Farina <[email protected]>

.github/workflows/docbuild.yml

@@ -0,0 +1,23 @@
+name: Build and Deploy Docs
+on:
+  push:
+    branches:
+      - docs
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected]
+
+      - name: Install and Build 🔧 # This will create version inside the 'build' folder.
+        run: |
+          cd docs
+          npm install
+          npm run build
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: docs/.vuepress/dist

docs/.vuepress/config.js

@@ -0,0 +1,266 @@
+module.exports = {
+  title: "Osmosis Docs",
+  markdown: {
+    lineNumbers: true,
+    extendMarkdown: (md) => {
+      md.use(require("markdown-it-footnote"));
+    },
+  },
+  base: "/",
+  description:
+    "Osmosis - The Cosmos Interchain AMM",
+  plugins: [
+    [
+      "@vuepress/register-components",
+      {
+        componentsDir: "theme/components",
+      },
+    ],
+    [
+      "vuepress-plugin-mathjax",
+      {
+        target: "svg",
+        macros: {
+          "*": "\\times",
+        },
+      },
+    ],
+  //  https://github.com/znicholasbrown/vuepress-plugin-code-copy
+  //  ["vuepress-plugin-code-copy", {
+  //    color: "#ffffff",
+  //    backgroundColor: "#3e3383",
+  //    }
+  //  ],
+    ["@maginapp/vuepress-plugin-copy-code", {
+      color: "#ffffff",
+      backgroundColor: "#ffffff",
+      align: { bottom: '7px', right: '12px' },
+      successText: " ",
+      duration: 350,
+    }
+    ],
+    [ 'tabs' ],
+  ],
+  head: [
+    [
+      "link",
+      {
+        rel: "stylesheet",
+        type: "text/css",
+        href: "https://cloud.typography.com/7420256/6416592/css/fonts.css",
+      },
+    ],
+    [
+      "link",
+      {
+        rel: "stylesheet",
+        type: "text/css",
+        href:
+          "https://fonts.googleapis.com/css?family=Material+Icons|Material+Icons+Outlined",
+      },
+    ],
+
+    [
+      "link",
+      {
+        rel: "stylesheet",
+        type: "text/css",
+        href:
+          "https://fonts.googleapis.com/css?family=Noto+Sans+KR:400,500,700&display=swap",
+      },
+    ],
+    [
+      "link",
+      {
+        rel: "icon",
+        type: "image/png",
+        href: "/img/favicon.png",
+      },
+    ],
+    [
+      "script",
+      {},
+      `window.onload = function() {
+        requestAnimationFrame(function() {
+          if (location.hash) {
+            const element = document.getElementById(location.hash.slice(1))
+
+            if (element) {
+              element.scrollIntoView()
+            }
+          }
+        })
+      }`,
+    ],
+    [
+      "meta",
+      {
+        property:"og:image",
+        content:"/img/osmosis-tile.png",
+      },
+    ],
+  ],
+  themeConfig: {
+    sidebarDepth: 3,
+    smoothScroll: true,
+    // overrideTheme: 'dark',
+    // prefersTheme: 'dark',
+    // overrideTheme: { light: [6, 18], dark: [18, 6] },
+    // theme: 'default-prefers-color-scheme',
+    logo: "/img/osmosis-logo-dark.svg",
+    logoDark: "/img/osmosis-logo-light.svg",
+    lastUpdated: "Updated on",
+    repo: "osmosis-labs/osmosis",
+    editLinks: true,
+    editLinkText: "Edit this page on GitHub",
+    docsBranch: 'main',
+    docsDir: "docs",
+    algolia: {
+      apiKey: "a95b2bd527cd60164d4e6e26c15fc4d1", //TODO GET KEY
+      indexName: "Docs",
+      appId: "YQ6N23UJAN"
+      // If Algolia did not provided you any `appId`, use `BH4D9OD16A` or remove this option
+    },
+    nav: [
+
+      { text: 'Home', link: '/', },
+      { text: 'Overview', link: '/overview/',},
+      { text: 'Develop', link: '/developing/',},
+      { text: 'Validate', link: '/validators/',},
+      { text: 'Integrate', link: '/integrate/',},
+      { text: 'Chat', link: 'https://v2.vuepress.vuejs.org/',},
+      {
+        text: "GitHub",
+        link: "https://github.com/osmosis-labs/osmosis",
+        icon: "/img/github.svg",
+      },
+    ],
+    sidebar: {
+      "/overview/": [
+        {
+          title: "About",
+          children: [
+            '/overview/',
+            '/overview/osmo',
+            '/overview/terminology',
+            '/overview/governance',
+          ],
+          collapsable: true,
+        },
+        {
+          title: "Osmosis AMM App",
+          children: [
+            '/overview/osmosis-app/',
+            '/overview/osmosis-app/learn-more',
+          ],
+          collapsable: true,
+        },
+        {
+          title: 'Wallets',
+          children: [
+            '/overview/wallets/keplr/install-keplr',
+            '/overview/wallets/keplr/create-keplr-wallet',
+            '/overview/wallets/keplr/import-account',
+            '/overview/wallets/keplr/import-ledger-account',
+          ],
+          collapsable: true,
+        },
+      ],
+
+
+      '/developing': [
+        {
+          title: 'Home',
+          children: [
+            '/developing/',
+          ],
+          collapsable: false,
+        },
+        {
+          title: 'Developer Guide',
+          children: [
+            '/developing/dev-guide',
+            '/developing/cli/',
+            '/developing/cli/install',
+          ],
+          collapsable: true,
+        },
+        {
+          title: "osmosisd",
+          children: [
+            "/developing/osmosisd/",
+            "/developing/osmosisd/commands",
+            "/developing/osmosisd/subcommands",
+          ],
+          collapsable: true,
+        },
+        {
+          title: 'Networks',
+          children: [
+            '/developing/network/join-testnet',
+            '/developing/network/join-mainnet',
+          ],
+          collapsable: true,
+        },
+        {
+          title: 'Modules',
+          children: [
+            "/developing/modules/",
+            "/developing/modules/spec-epochs",
+            "/developing/modules/spec-gamm",
+            "/developing/modules/spec-gov",
+            "/developing/modules/spec-lockup",
+            "/developing/modules/spec-mint",
+            "/developing/modules/spec-incentives",
+            "/developing/modules/spec-pool-incentives"
+          ],
+          collapsable: true,
+        },
+      ],
+      '/validators': [
+        {
+          title: 'Home',
+          children: [
+            '/validators/',
+          ],
+          collapsable: false,
+        },
+        {
+          title: 'Validate',
+          children: [
+            '/validators/validating-testnet',
+            '/validators/validating-mainnet',
+          ],
+          collapsable: true,
+        },
+      ],
+
+      '/integrate': [
+        {
+          title: 'Home',
+          children: [
+            '/integrate/',
+          ],
+          collapsable: false,
+        },
+        {
+          title: 'Integrate',
+          children: [
+            '/integrate/token-listings',
+          ],
+          collapsable: true,
+        },
+      ],
+      "/": [
+        {
+          title: "Overview",
+          children: [
+            "/history-and-changes",
+          ],
+          collapsable: false,
+        },
+      ],
+    },
+
+  },
+};