Merge pull request #2738 from cosmos/zach/examples

docs: update config.js & Makefile
cosmos · Nov 9, 2018 · 59651c9 · 59651c9
2 parents c664917 + 85a140b
commit 59651c9
Show file tree

Hide file tree

Showing 16 changed files with 55 additions and 122 deletions.
diff --git a/Makefile b/Makefile
@@ -60,26 +60,26 @@ endif
 
 build_examples:
 ifeq ($(OS),Windows_NT)
-	go build $(BUILD_FLAGS) -o build/basecoind.exe ./examples/basecoin/cmd/basecoind
-	go build $(BUILD_FLAGS) -o build/basecli.exe ./examples/basecoin/cmd/basecli
-	go build $(BUILD_FLAGS) -o build/democoind.exe ./examples/democoin/cmd/democoind
-	go build $(BUILD_FLAGS) -o build/democli.exe ./examples/democoin/cmd/democli
+	go build $(BUILD_FLAGS) -o build/basecoind.exe ./docs/examples/basecoin/cmd/basecoind
+	go build $(BUILD_FLAGS) -o build/basecli.exe ./docs/examples/basecoin/cmd/basecli
+	go build $(BUILD_FLAGS) -o build/democoind.exe ./docs/examples/democoin/cmd/democoind
+	go build $(BUILD_FLAGS) -o build/democli.exe ./docs/examples/democoin/cmd/democli
 else
-	go build $(BUILD_FLAGS) -o build/basecoind ./examples/basecoin/cmd/basecoind
-	go build $(BUILD_FLAGS) -o build/basecli ./examples/basecoin/cmd/basecli
-	go build $(BUILD_FLAGS) -o build/democoind ./examples/democoin/cmd/democoind
-	go build $(BUILD_FLAGS) -o build/democli ./examples/democoin/cmd/democli
+	go build $(BUILD_FLAGS) -o build/basecoind ./docs/examples/basecoin/cmd/basecoind
+	go build $(BUILD_FLAGS) -o build/basecli ./docs/examples/basecoin/cmd/basecli
+	go build $(BUILD_FLAGS) -o build/democoind ./docs/examples/democoin/cmd/democoind
+	go build $(BUILD_FLAGS) -o build/democli ./docs/examples/democoin/cmd/democli
 endif
 
 install: check-ledger update_gaia_lite_docs
 	go install $(BUILD_FLAGS) ./cmd/gaia/cmd/gaiad
 	go install $(BUILD_FLAGS) ./cmd/gaia/cmd/gaiacli
 
 install_examples:
-	go install $(BUILD_FLAGS) ./examples/basecoin/cmd/basecoind
-	go install $(BUILD_FLAGS) ./examples/basecoin/cmd/basecli
-	go install $(BUILD_FLAGS) ./examples/democoin/cmd/democoind
-	go install $(BUILD_FLAGS) ./examples/democoin/cmd/democli
+	go install $(BUILD_FLAGS) ./docs/examples/basecoin/cmd/basecoind
+	go install $(BUILD_FLAGS) ./docs/examples/basecoin/cmd/basecli
+	go install $(BUILD_FLAGS) ./docs/examples/democoin/cmd/democoind
+	go install $(BUILD_FLAGS) ./docs/examples/democoin/cmd/democli
 
 install_cosmos-sdk-cli:
 	go install $(BUILD_FLAGS) ./cmd/cosmos-sdk-cli

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -12,99 +12,32 @@ module.exports = {
     nav: [{ text: "Back to Cosmos", link: "https://cosmos.network" }],
     sidebar: [
       {
-        title: "Introduction",
+        title: "Gaia",
         collapsable: false,
         children: [
-          "/introduction/cosmos-hub",
-          "/introduction/tendermint-cosmos",
-          "/introduction/tendermint"
-        ]
-      },
-      {
-        title: "Getting Started",
-        collapsable: false,
-        children: [
-          "/getting-started/voyager",
-          "/getting-started/installation",
-          "/getting-started/join-testnet",
-          "/getting-started/networks"
-        ]
-      },
-      {
-        title: "Cosmos SDK",
-        collapsable: false,
-        children: [
-          ["/sdk/overview", "Overview"],
-          ["/sdk/core/intro", "Core"],
-          "/sdk/core/app1",
-          "/sdk/core/app2",
-          "/sdk/core/app3",
-          "/sdk/core/app4",
-          "/sdk/core/app5",
-          // "/sdk/modules",
-          "/sdk/clients",
-          "/sdk/cosmos-sdk-cli"
-        ]
-      },
-      // {
-      //   title: "Specifications",
-      //   collapsable: false,
-      //   children: [
-      //     ["/specs/overview", "Overview"],
-      //     "/specs/governance",
-      //     "/specs/ibc",
-      //     "/specs/staking",
-      //     "/specs/icts",
-      //   ]
-      // },
-      {
-        title: "SDK by Examples - Simple Governance",
-        collapsable: false,
-        children: [
-          ["/sdk/sdk-by-examples/simple-governance/intro", "Intro"],
-          "/sdk/sdk-by-examples/simple-governance/setup-and-design",
-          "/sdk/sdk-by-examples/simple-governance/app-init",
-          "/sdk/sdk-by-examples/simple-governance/simple-gov-module",
-          "/sdk/sdk-by-examples/simple-governance/bridging-it-all",
-          "/sdk/sdk-by-examples/simple-governance/running-the-application"
-        ]
-      },
-      {
-        title: "Light Client",
-        collapsable: false,
-        children: [
-	  "/lite/",
-	  "/lite/getting_started"
-	]
-      },
-      {
-        title: "Validators",
-        collapsable: false,
-        children: [
-          ["/validators/overview", "Overview"],
-          ["/validators/security", "Security"],
-          ["/validators/validator-setup", "Validator Setup"],
-          "/validators/validator-faq"
+          "/gaia/installation",
+          "/gaia/join-testnet",
+          "/gaia/networks",
+          "/gaia/validators/overview",
+          "/gaia/validators/security",
+          "/gaia/validators/validator-faq",
+          "/gaia/validators/validator-setup"
         ]
       },
       {
         title: "Clients",
         collapsable: false,
         children: [
-          ["/clients/service-providers", "Service Providers"]
-        ]
-      },
-      {
-        title: "Resources",
-        collapsable: false,
-        children: [
-          // ["/resources/faq" "General"],
-          "/resources/delegator-faq",
-          ["/resources/whitepaper", "Whitepaper - English"],
-          ["/resources/whitepaper-ko", "Whitepaper - 한국어"],
-          ["/resources/whitepaper-zh-CN", "Whitepaper - 中文"],
-          ["/resources/whitepaper-pt", "Whitepaper - Português"]
-        ]
+	  "/clients/clients",
+	  "/clients/cli",
+	  "/clients/keys",
+	  "/clients/ledger",
+	  "/clients/node",
+	  "/clients/service-providers",
+	  "/lite/", // this renders the readme
+	  "/lite/getting_started",
+	  "/lite/specification"
+	]
       }
     ]
   }

diff --git a/docs/examples/basecoin/app/app.go b/docs/examples/basecoin/app/app.go
@@ -6,7 +6,7 @@ import (
 
 	bam "github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/basecoin/types"
+	"github.com/cosmos/cosmos-sdk/docs/examples/basecoin/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
 	"github.com/cosmos/cosmos-sdk/x/bank"

diff --git a/docs/examples/basecoin/app/app_test.go b/docs/examples/basecoin/app/app_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/basecoin/types"
+	"github.com/cosmos/cosmos-sdk/docs/examples/basecoin/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
 	"github.com/stretchr/testify/require"

diff --git a/docs/examples/basecoin/cmd/basecli/main.go b/docs/examples/basecoin/cmd/basecli/main.go
@@ -7,8 +7,8 @@ import (
 	_ "github.com/cosmos/cosmos-sdk/client/lcd/statik"
 	"github.com/cosmos/cosmos-sdk/client/rpc"
 	"github.com/cosmos/cosmos-sdk/client/tx"
-	"github.com/cosmos/cosmos-sdk/examples/basecoin/app"
-	"github.com/cosmos/cosmos-sdk/examples/basecoin/types"
+	"github.com/cosmos/cosmos-sdk/docs/examples/basecoin/app"
+	"github.com/cosmos/cosmos-sdk/docs/examples/basecoin/types"
 	"github.com/cosmos/cosmos-sdk/version"
 	authcmd "github.com/cosmos/cosmos-sdk/x/auth/client/cli"
 	bankcmd "github.com/cosmos/cosmos-sdk/x/bank/client/cli"

diff --git a/docs/examples/basecoin/cmd/basecoind/main.go b/docs/examples/basecoin/cmd/basecoind/main.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/basecoin/app"
+	"github.com/cosmos/cosmos-sdk/docs/examples/basecoin/app"
 	"github.com/cosmos/cosmos-sdk/server"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"

diff --git a/docs/examples/democoin/app/app.go b/docs/examples/democoin/app/app.go
@@ -17,11 +17,11 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/bank"
 	"github.com/cosmos/cosmos-sdk/x/ibc"
 
-	"github.com/cosmos/cosmos-sdk/examples/democoin/types"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/cool"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/pow"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/simplestake"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/sketchy"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/types"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/cool"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/pow"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/simplestake"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/sketchy"
 )
 
 const (

diff --git a/docs/examples/democoin/app/app_test.go b/docs/examples/democoin/app/app_test.go
@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/types"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/cool"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/types"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/cool"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
 	"github.com/stretchr/testify/require"

diff --git a/docs/examples/democoin/cmd/democli/main.go b/docs/examples/democoin/cmd/democli/main.go
@@ -16,11 +16,11 @@ import (
 	bankcmd "github.com/cosmos/cosmos-sdk/x/bank/client/cli"
 	ibccmd "github.com/cosmos/cosmos-sdk/x/ibc/client/cli"
 
-	"github.com/cosmos/cosmos-sdk/examples/democoin/app"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/types"
-	coolcmd "github.com/cosmos/cosmos-sdk/examples/democoin/x/cool/client/cli"
-	powcmd "github.com/cosmos/cosmos-sdk/examples/democoin/x/pow/client/cli"
-	simplestakingcmd "github.com/cosmos/cosmos-sdk/examples/democoin/x/simplestake/client/cli"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/app"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/types"
+	coolcmd "github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/cool/client/cli"
+	powcmd "github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/pow/client/cli"
+	simplestakingcmd "github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/simplestake/client/cli"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )

diff --git a/docs/examples/democoin/cmd/democoind/main.go b/docs/examples/democoin/cmd/democoind/main.go
@@ -21,7 +21,7 @@ import (
 
 	gaiaInit "github.com/cosmos/cosmos-sdk/cmd/gaia/init"
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/app"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/app"
 	"github.com/cosmos/cosmos-sdk/server"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )

diff --git a/docs/examples/democoin/types/account.go b/docs/examples/democoin/types/account.go
@@ -5,8 +5,8 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
 
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/cool"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/pow"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/cool"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/pow"
 )
 
 var _ auth.Account = (*AppAccount)(nil)

diff --git a/docs/examples/democoin/x/assoc/validator_set_test.go b/docs/examples/democoin/x/assoc/validator_set_test.go
@@ -10,7 +10,7 @@ import (
 	dbm "github.com/tendermint/tendermint/libs/db"
 
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/mock"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/mock"
 	"github.com/cosmos/cosmos-sdk/store"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )

diff --git a/docs/examples/democoin/x/cool/client/cli/tx.go b/docs/examples/democoin/x/cool/client/cli/tx.go
@@ -6,7 +6,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/client/utils"
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/cool"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/cool"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authcmd "github.com/cosmos/cosmos-sdk/x/auth/client/cli"
 	authtxb "github.com/cosmos/cosmos-sdk/x/auth/client/txbuilder"

diff --git a/docs/examples/democoin/x/oracle/oracle_test.go b/docs/examples/democoin/x/oracle/oracle_test.go
@@ -10,7 +10,7 @@ import (
 	dbm "github.com/tendermint/tendermint/libs/db"
 
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/mock"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/mock"
 	"github.com/cosmos/cosmos-sdk/store"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )

diff --git a/docs/examples/democoin/x/pow/client/cli/tx.go b/docs/examples/democoin/x/pow/client/cli/tx.go
@@ -6,7 +6,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/client/utils"
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/pow"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/pow"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authcmd "github.com/cosmos/cosmos-sdk/x/auth/client/cli"
 	authtxb "github.com/cosmos/cosmos-sdk/x/auth/client/txbuilder"

diff --git a/docs/examples/democoin/x/simplestake/client/cli/commands.go b/docs/examples/democoin/x/simplestake/client/cli/commands.go
@@ -7,7 +7,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/client/utils"
 	"github.com/cosmos/cosmos-sdk/codec"
-	"github.com/cosmos/cosmos-sdk/examples/democoin/x/simplestake"
+	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/simplestake"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authcmd "github.com/cosmos/cosmos-sdk/x/auth/client/cli"
 	authtxb "github.com/cosmos/cosmos-sdk/x/auth/client/txbuilder"