From a79749564eb16d158804cd2638f31e69c87a0801 Mon Sep 17 00:00:00 2001 From: Marko Date: Tue, 18 Jun 2019 14:04:47 +0200 Subject: [PATCH] Merge PR #4571: Update .vuepress --- contrib/runsim/main.go | 2 +- docs/.vuepress/config.js | 20 +++++++++++--------- docs/architecture/adr-002-docs-structure.md | 16 ++++++---------- x/bank/alias.go | 18 +++++++++--------- x/staking/exported/exported.go | 2 +- x/staking/types/keys.go | 1 - 6 files changed, 28 insertions(+), 31 deletions(-) diff --git a/contrib/runsim/main.go b/contrib/runsim/main.go index ba96c5cae..b54be8ba7 100644 --- a/contrib/runsim/main.go +++ b/contrib/runsim/main.go @@ -26,7 +26,7 @@ var ( 989182, 89182391, 11, 22, 44, 77, 99, 2020, 3232, 123123, 124124, 582582, 18931893, 29892989, 30123012, 47284728, 7601778, 8090485, - 977367484, 491163361, 424254581, 673398983, + 977367484, 491163361, 424254581, 673398983, } // goroutine-safe process map diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 2a122a009..a53ca84fa 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -12,11 +12,11 @@ module.exports = { editLinks: true, docsDir: "docs", docsBranch: "develop", - editLinkText: 'Edit this page on Github', + editLinkText: "Edit this page on Github", lastUpdated: true, algolia: { - apiKey: 'a6e2f64347bb826b732e118c1366819a', - indexName: 'cosmos_network', + apiKey: "a6e2f64347bb826b732e118c1366819a", + indexName: "cosmos_network", debug: false }, nav: [ @@ -43,11 +43,13 @@ module.exports = { "/tutorial/app-design", "/tutorial/app-init", "/tutorial/types", + "/tutorial/key", "/tutorial/keeper", "/tutorial/msgs-handlers", "/tutorial/set-name", "/tutorial/buy-name", "/tutorial/queriers", + "/tutorial/alias", "/tutorial/codec", "/tutorial/cli", "/tutorial/rest", @@ -64,14 +66,14 @@ module.exports = { title: "Clients", collapsable: true, children: [ - "/clients/", + "/clients/", "/clients/cli", "/clients/service-providers", - "/clients/lite/", // this renders the readme - "/clients/lite/getting_started", - "/clients/lite/specification" - ] + "/clients/lite/", // this renders the readme + "/clients/lite/getting_started", + "/clients/lite/specification" + ] } ] } -} +}; diff --git a/docs/architecture/adr-002-docs-structure.md b/docs/architecture/adr-002-docs-structure.md index ef7a14129..656a72524 100644 --- a/docs/architecture/adr-002-docs-structure.md +++ b/docs/architecture/adr-002-docs-structure.md @@ -5,6 +5,7 @@ There is a need for a scalable structure of the SDK documentation. Current documentation includes a lot of non-related SDK material, is difficult to maintain and hard to follow as a user. Ideally, we would have: + - All docs related to dev frameworks or tools live in their respective github repos (sdk repo would contain sdk docs, hub repo would contain hub docs, lotion repo would contain lotion docs, etc.) - All other docs (faqs, whitepaper, high-level material about Cosmos) would live on the website. @@ -16,13 +17,6 @@ Re-structure the `/docs` folder of the SDK github repo as follows: docs/ ├── README ├── intro/ -├── gaia/ -│ ├── overview.md -│ ├── install.md -│ ├── join-testnet.md -│ ├── validator-node.md -│ ├── validator-faq.md -│ └── delegator-faq.md ├── concepts/ │ ├── baseapp │ ├── types @@ -37,7 +31,9 @@ docs/ ├── clients/ │ ├── lite/ │ ├── service-providers +├── modules/ ├── spec/ +├── translations/ └── architecture/ ``` @@ -45,21 +41,21 @@ The files in each sub-folders do not matter and will likely change. What matters - `README`: Landing page of the docs. - `into`: Introductory material. Goal is to have a short explainer of the SDK and then channel people to the resource they need. The [sdk-tutorial](https://github.com/cosmos/sdk-application-tutorial/) will be highlighted, as well as the `godocs`. -- `gaia`: Contains all docs related to the `gaia` application. Will later be renamed to `cosmos-hub` or `chub` and probably moved to its own repository. - `concepts`: Contains high-level explanations of the abstractions of the SDK. It does not contain specific code implementation and does not need to be updated often. **It is not an API specification of the interfaces**. API spec is the `godoc`. - `clients`: Contains specs and info about the various SDK clients. - `spec`: Contains specs of modules, and others. +- `modules`: Contains links to `godocs` and the spec of the modules. - `architecture`: Contains architecture-related docs like the present one. +- `translations`: Contains different translations of the documentation. Website docs sidebar will only include the following sections: - `README` - `intro` -- `gaia` - `concepts` - `clients` -`architecture` and `examples` need not be displayed on the website. As for `modules`, we might need to think about creating a modules manager, but this is out of scope for this document. +`architecture` need not be displayed on the website. ## Status diff --git a/x/bank/alias.go b/x/bank/alias.go index 75f71aaa0..0a8c2a3f2 100644 --- a/x/bank/alias.go +++ b/x/bank/alias.go @@ -20,15 +20,15 @@ const ( var ( // functions aliases - RegisterCodec = types.RegisterCodec - ErrNoInputs = types.ErrNoInputs - ErrNoOutputs = types.ErrNoOutputs - ErrInputOutputMismatch = types.ErrInputOutputMismatch - ErrSendDisabled = types.ErrSendDisabled - NewBaseKeeper = keeper.NewBaseKeeper - NewInput = types.NewInput - NewOutput = types.NewOutput - ParamKeyTable = types.ParamKeyTable + RegisterCodec = types.RegisterCodec + ErrNoInputs = types.ErrNoInputs + ErrNoOutputs = types.ErrNoOutputs + ErrInputOutputMismatch = types.ErrInputOutputMismatch + ErrSendDisabled = types.ErrSendDisabled + NewBaseKeeper = keeper.NewBaseKeeper + NewInput = types.NewInput + NewOutput = types.NewOutput + ParamKeyTable = types.ParamKeyTable // variable aliases ModuleCdc = types.ModuleCdc diff --git a/x/staking/exported/exported.go b/x/staking/exported/exported.go index cf2417cbe..88fa00c02 100644 --- a/x/staking/exported/exported.go +++ b/x/staking/exported/exported.go @@ -25,7 +25,7 @@ type ValidatorI interface { GetConsAddr() sdk.ConsAddress // validation consensus address GetTokens() sdk.Int // validation tokens GetBondedTokens() sdk.Int // validator bonded tokens - GetConsensusPower() int64 // validation power in tendermint + GetConsensusPower() int64 // validation power in tendermint GetCommission() sdk.Dec // validator commission rate GetMinSelfDelegation() sdk.Int // validator minimum self delegation GetDelegatorShares() sdk.Dec // total outstanding delegator shares diff --git a/x/staking/types/keys.go b/x/staking/types/keys.go index dce8958e7..233daa22b 100644 --- a/x/staking/types/keys.go +++ b/x/staking/types/keys.go @@ -7,7 +7,6 @@ import ( sdk "github.com/cosmos/cosmos-sdk/types" ) - const ( // ModuleName is the name of the staking module ModuleName = "staking"