From 55cc086f55fa0bffd03b8df72aacfd2a6d3cbb11 Mon Sep 17 00:00:00 2001 From: rigelrozanski Date: Fri, 18 May 2018 15:08:12 -0400 Subject: [PATCH] docs reorganization --- docs/{old => _attic}/basecoin/basics.rst | 0 docs/{old => _attic}/basecoin/extensions.rst | 0 docs/{old => _attic}/glossary.rst | 0 docs/{old => _attic}/ibc.rst | 0 docs/{old => _attic}/keys.md | 0 docs/{old => _attic}/replay-protection.rst | 0 docs/{old => _attic}/staking/key-management.rst | 0 docs/{old => _attic}/staking/local-testnet.rst | 0 docs/{old => _attic}/staking/public-testnet.rst | 0 docs/{old => _attic}/stakingSpec1.md | 0 docs/{old => _attic}/stakingSpec2.md | 0 docs/{ => guides}/Makefile | 0 docs/{ => guides}/conf.py | 0 docs/{ => guides}/guide.md | 0 docs/{ => guides}/index.rst | 0 docs/{ => guides}/make.bat | 0 docs/{ => guides}/sdk/apps.md | 0 docs/{ => guides}/sdk/install.rst | 0 docs/{ => guides}/sdk/key-management.rst | 0 docs/{ => guides}/sdk/lcd-rest-api.yaml | 0 docs/{ => guides}/sdk/overview.rst | 0 docs/{ => guides}/staking/intro.rst | 0 docs/{spec => guides}/staking/overview.md | 2 ++ docs/{ => guides}/staking/testnet.rst | 0 .../fee_distribution_model.xlsx | Bin docs/spec/{rewards => provisioning}/overview.md | 0 docs/spec/staking/state.md | 6 ++---- 27 files changed, 4 insertions(+), 4 deletions(-) rename docs/{old => _attic}/basecoin/basics.rst (100%) rename docs/{old => _attic}/basecoin/extensions.rst (100%) rename docs/{old => _attic}/glossary.rst (100%) rename docs/{old => _attic}/ibc.rst (100%) rename docs/{old => _attic}/keys.md (100%) rename docs/{old => _attic}/replay-protection.rst (100%) rename docs/{old => _attic}/staking/key-management.rst (100%) rename docs/{old => _attic}/staking/local-testnet.rst (100%) rename docs/{old => _attic}/staking/public-testnet.rst (100%) rename docs/{old => _attic}/stakingSpec1.md (100%) rename docs/{old => _attic}/stakingSpec2.md (100%) rename docs/{ => guides}/Makefile (100%) rename docs/{ => guides}/conf.py (100%) rename docs/{ => guides}/guide.md (100%) rename docs/{ => guides}/index.rst (100%) rename docs/{ => guides}/make.bat (100%) rename docs/{ => guides}/sdk/apps.md (100%) rename docs/{ => guides}/sdk/install.rst (100%) rename docs/{ => guides}/sdk/key-management.rst (100%) rename docs/{ => guides}/sdk/lcd-rest-api.yaml (100%) rename docs/{ => guides}/sdk/overview.rst (100%) rename docs/{ => guides}/staking/intro.rst (100%) rename docs/{spec => guides}/staking/overview.md (99%) rename docs/{ => guides}/staking/testnet.rst (100%) rename docs/spec/{rewards => provisioning}/fee_distribution_model.xlsx (100%) rename docs/spec/{rewards => provisioning}/overview.md (100%) diff --git a/docs/old/basecoin/basics.rst b/docs/_attic/basecoin/basics.rst similarity index 100% rename from docs/old/basecoin/basics.rst rename to docs/_attic/basecoin/basics.rst diff --git a/docs/old/basecoin/extensions.rst b/docs/_attic/basecoin/extensions.rst similarity index 100% rename from docs/old/basecoin/extensions.rst rename to docs/_attic/basecoin/extensions.rst diff --git a/docs/old/glossary.rst b/docs/_attic/glossary.rst similarity index 100% rename from docs/old/glossary.rst rename to docs/_attic/glossary.rst diff --git a/docs/old/ibc.rst b/docs/_attic/ibc.rst similarity index 100% rename from docs/old/ibc.rst rename to docs/_attic/ibc.rst diff --git a/docs/old/keys.md b/docs/_attic/keys.md similarity index 100% rename from docs/old/keys.md rename to docs/_attic/keys.md diff --git a/docs/old/replay-protection.rst b/docs/_attic/replay-protection.rst similarity index 100% rename from docs/old/replay-protection.rst rename to docs/_attic/replay-protection.rst diff --git a/docs/old/staking/key-management.rst b/docs/_attic/staking/key-management.rst similarity index 100% rename from docs/old/staking/key-management.rst rename to docs/_attic/staking/key-management.rst diff --git a/docs/old/staking/local-testnet.rst b/docs/_attic/staking/local-testnet.rst similarity index 100% rename from docs/old/staking/local-testnet.rst rename to docs/_attic/staking/local-testnet.rst diff --git a/docs/old/staking/public-testnet.rst b/docs/_attic/staking/public-testnet.rst similarity index 100% rename from docs/old/staking/public-testnet.rst rename to docs/_attic/staking/public-testnet.rst diff --git a/docs/old/stakingSpec1.md b/docs/_attic/stakingSpec1.md similarity index 100% rename from docs/old/stakingSpec1.md rename to docs/_attic/stakingSpec1.md diff --git a/docs/old/stakingSpec2.md b/docs/_attic/stakingSpec2.md similarity index 100% rename from docs/old/stakingSpec2.md rename to docs/_attic/stakingSpec2.md diff --git a/docs/Makefile b/docs/guides/Makefile similarity index 100% rename from docs/Makefile rename to docs/guides/Makefile diff --git a/docs/conf.py b/docs/guides/conf.py similarity index 100% rename from docs/conf.py rename to docs/guides/conf.py diff --git a/docs/guide.md b/docs/guides/guide.md similarity index 100% rename from docs/guide.md rename to docs/guides/guide.md diff --git a/docs/index.rst b/docs/guides/index.rst similarity index 100% rename from docs/index.rst rename to docs/guides/index.rst diff --git a/docs/make.bat b/docs/guides/make.bat similarity index 100% rename from docs/make.bat rename to docs/guides/make.bat diff --git a/docs/sdk/apps.md b/docs/guides/sdk/apps.md similarity index 100% rename from docs/sdk/apps.md rename to docs/guides/sdk/apps.md diff --git a/docs/sdk/install.rst b/docs/guides/sdk/install.rst similarity index 100% rename from docs/sdk/install.rst rename to docs/guides/sdk/install.rst diff --git a/docs/sdk/key-management.rst b/docs/guides/sdk/key-management.rst similarity index 100% rename from docs/sdk/key-management.rst rename to docs/guides/sdk/key-management.rst diff --git a/docs/sdk/lcd-rest-api.yaml b/docs/guides/sdk/lcd-rest-api.yaml similarity index 100% rename from docs/sdk/lcd-rest-api.yaml rename to docs/guides/sdk/lcd-rest-api.yaml diff --git a/docs/sdk/overview.rst b/docs/guides/sdk/overview.rst similarity index 100% rename from docs/sdk/overview.rst rename to docs/guides/sdk/overview.rst diff --git a/docs/staking/intro.rst b/docs/guides/staking/intro.rst similarity index 100% rename from docs/staking/intro.rst rename to docs/guides/staking/intro.rst diff --git a/docs/spec/staking/overview.md b/docs/guides/staking/overview.md similarity index 99% rename from docs/spec/staking/overview.md rename to docs/guides/staking/overview.md index 053d59d7ab..9867dc95e3 100644 --- a/docs/spec/staking/overview.md +++ b/docs/guides/staking/overview.md @@ -1,3 +1,5 @@ +//TODO update .rst + # Staking Module ## Overview diff --git a/docs/staking/testnet.rst b/docs/guides/staking/testnet.rst similarity index 100% rename from docs/staking/testnet.rst rename to docs/guides/staking/testnet.rst diff --git a/docs/spec/rewards/fee_distribution_model.xlsx b/docs/spec/provisioning/fee_distribution_model.xlsx similarity index 100% rename from docs/spec/rewards/fee_distribution_model.xlsx rename to docs/spec/provisioning/fee_distribution_model.xlsx diff --git a/docs/spec/rewards/overview.md b/docs/spec/provisioning/overview.md similarity index 100% rename from docs/spec/rewards/overview.md rename to docs/spec/provisioning/overview.md diff --git a/docs/spec/staking/state.md b/docs/spec/staking/state.md index 28e4faaf2c..397ce1c1c7 100644 --- a/docs/spec/staking/state.md +++ b/docs/spec/staking/state.md @@ -2,15 +2,13 @@ ## State The staking module persists the following information to the store: -* `GlobalState`, a struct describing the global pools, inflation, and - fees +* `Params`, a struct describing the global pools, inflation, and fees +* `Pool`, a struct describing the global pools, inflation, and fees * `ValidatorValidators: => `, a map of all validators (including current validators) in the store, indexed by their public key and shares in the global pool. * `DelegatorBonds: < delegator-address | validator-pubkey > => `. a map of all delegations by a delegator to a validator, indexed by delegator address and validator pubkey. public key -* `UnbondQueue`, the queue of unbonding delegations -* `RedelegateQueue`, the queue of re-delegations ### Global State