From 24e8bd991dd31e4a1cb253cf28963dc8d1f1e9ec Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Sat, 8 Apr 2023 12:46:47 +0200 Subject: [PATCH 1/3] docs: simplifying spec category --- docs/docusaurus.config.js | 8 +++++ docs/spec/circuit-breaker/README.md | 16 ---------- docs/spec/reserve-pool/README.md | 4 --- docs/spec/store/interblock-cache.md | 47 ++++++++++++++--------------- tools/cosmovisor/README.md | 29 +++++++++--------- x/distribution/README.md | 5 +++ 6 files changed, 51 insertions(+), 58 deletions(-) delete mode 100644 docs/spec/circuit-breaker/README.md delete mode 100644 docs/spec/reserve-pool/README.md diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 43d56957944c..631ebd6c29c7 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -389,6 +389,14 @@ const config = { from: ["/main/modules/capability"], to: "/main/ecosystem", }, + { + from: ["/main/spec/circuit-breaker"], + to: "/main/modules/circuit", + }, + { + from: ["/main/spec/reserve-pool"], + to: "/main/modules/distribution", + }, { from: ["/main/run-node/cosmovisor"], to: "/main/tooling/cosmovisor", diff --git a/docs/spec/circuit-breaker/README.md b/docs/spec/circuit-breaker/README.md deleted file mode 100644 index 1956704bd592..000000000000 --- a/docs/spec/circuit-breaker/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Concepts - -The intention of the circuit breaker is to have a contingency plan for a -running network which maintains network liveness. This can be achieved through -selectively "pausing" functionality of specific modules on a running network. -The circuit breaker is intended to be enabled through either: - -* governance -* for emergencies a special subset of accounts selected by the state machine -* a transaction which proves the expected behaviour is broken - -## Pause state - -The basic pause state of any module simply disables all message routes to -that module. Beyond that, it may be a appropriate for different modules to -process begin-block/end-block in an altered "safe" way. diff --git a/docs/spec/reserve-pool/README.md b/docs/spec/reserve-pool/README.md deleted file mode 100644 index 6912ab0c482e..000000000000 --- a/docs/spec/reserve-pool/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Reserve Pool - -The reserve pool is the pool of collected funds for use by governance taken via the `CommunityTax`. -Currently with the Cosmos SDK, tokens collected by the CommunityTax are accounted for but unspendable. diff --git a/docs/spec/store/interblock-cache.md b/docs/spec/store/interblock-cache.md index e25cdc11eb15..f2153a649dc3 100644 --- a/docs/spec/store/interblock-cache.md +++ b/docs/spec/store/interblock-cache.md @@ -1,25 +1,24 @@ # Inter-block Cache -- [Inter-block cache](#inter-block-cache) - - [Synopsis](#synopsis) - - [Overview and basic concepts](#overview-and-basic-concepts) - - [Motivation](#motivation) - - [Definitions](#definitions) - - [System model and properties](#system-model-and-properties) - - [Assumptions](#assumptions) - - [Properties](#properties) - - [Thread safety](#thread-safety) - - [Crash recovery](#crash-recovery) - - [Iteration](#iteration) - - [Technical specification](#technical-specification) - - [General design](#general-design) - - [API](#api) - - [CommitKVCacheManager](#commitkvcachemanager) - - [CommitKVStoreCache](#commitkvstorecache) - - [Implementation details](#implementation-details) - - [History](#history) - - [Copyright](#copyright) - +* [Inter-block Cache](#inter-block-cache) + * [Synopsis](#synopsis) + * [Overview and basic concepts](#overview-and-basic-concepts) + * [Motivation](#motivation) + * [Definitions](#definitions) + * [System model and properties](#system-model-and-properties) + * [Assumptions](#assumptions) + * [Properties](#properties) + * [Thread safety](#thread-safety) + * [Crash recovery](#crash-recovery) + * [Iteration](#iteration) + * [Technical specification](#technical-specification) + * [General design](#general-design) + * [API](#api) + * [CommitKVCacheManager](#commitkvcachemanager) + * [CommitKVStoreCache](#commitkvstorecache) + * [Implementation details](#implementation-details) + * [History](#history) + * [Copyright](#copyright) ## Synopsis @@ -33,9 +32,9 @@ The goal of the inter-block cache is to allow SDK modules to have fast access to ### Definitions -- `Store key` uniquely identifies a store. -- `KVCache` is a `CommitKVStore` wrapped with a cache. -- `Cache manager` is a key component of the inter-block cache responsible for maintaining a map from `store keys` to `KVCaches`. +* `Store key` uniquely identifies a store. +* `KVCache` is a `CommitKVStore` wrapped with a cache. +* `Cache manager` is a key component of the inter-block cache responsible for maintaining a map from `store keys` to `KVCaches`. ## System model and properties @@ -287,4 +286,4 @@ Dec 20, 2022 - Initial draft finished and submitted as a PR ## Copyright -All content herein is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). \ No newline at end of file +All content herein is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/tools/cosmovisor/README.md b/tools/cosmovisor/README.md index 46503f29776c..6f6df095d7d0 100644 --- a/tools/cosmovisor/README.md +++ b/tools/cosmovisor/README.md @@ -6,20 +6,21 @@ sidebar_position: 1 `cosmovisor` is a small process manager for Cosmos SDK application binaries that monitors the governance module for incoming chain upgrade proposals. If it sees a proposal that gets approved, `cosmovisor` can automatically download the new binary, stop the current binary, switch from the old binary to the new one, and finally restart the node with the new binary. - * [Design](#design) - * [Contributing](#contributing) - * [Setup](#setup) - * [Installation](#installation) - * [Command Line Arguments And Environment Variables](#command-line-arguments-and-environment-variables) - * [Folder Layout](#folder-layout) - * [Usage](#usage) - * [Initialization](#initialization) - * [Detecting Upgrades](#detecting-upgrades) - * [Auto-Download](#auto-download) - * [Example: SimApp Upgrade](#example-simapp-upgrade) - * [Chain Setup](#chain-setup) - * [Prepare Cosmovisor and Start the Chain](#prepare-cosmovisor-and-start-the-chain) - * [Update App](#update-app) +* [Design](#design) +* [Contributing](#contributing) +* [Setup](#setup) + * [Installation](#installation) + * [Command Line Arguments And Environment Variables](#command-line-arguments-and-environment-variables) + * [Folder Layout](#folder-layout) +* [Usage](#usage) + * [Initialization](#initialization) + * [Detecting Upgrades](#detecting-upgrades) + * [Auto-Download](#auto-download) +* [Example: SimApp Upgrade](#example-simapp-upgrade) + * [Chain Setup](#chain-setup) + * [Prepare Cosmovisor and Start the Chain](#prepare-cosmovisor-and-start-the-chain) + * [Update App](#update-app) + ## Design Cosmovisor is designed to be used as a wrapper for a `Cosmos SDK` app: diff --git a/x/distribution/README.md b/x/distribution/README.md index 1949f6c79ef9..f730ed379a9b 100644 --- a/x/distribution/README.md +++ b/x/distribution/README.md @@ -517,6 +517,11 @@ The distribution module contains the following parameters: * [0] `communitytax` must be positive and cannot exceed 1.00. * `baseproposerreward` and `bonusproposerreward` were parameters that are deprecated in v0.47 and are not used. +:::note +The reserve pool is the pool of collected funds for use by governance taken via the `CommunityTax`. +Currently with the Cosmos SDK, tokens collected by the CommunityTax are accounted for but unspendable. +::: + ## Client ## CLI From 44400e2e8ccdbdadfd4b87c144e2f8a15e1f4050 Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Sat, 8 Apr 2023 12:59:13 +0200 Subject: [PATCH 2/3] updates --- docs/docs/README.md | 2 +- docs/docs/ecosystem/README.md | 38 ----------------------------- docs/docs/ecosystem/_category_.json | 5 ---- docs/docusaurus.config.js | 4 +-- docs/rfc/_category_.json | 2 +- docs/sidebars.js | 7 +++++- docs/spec/README.md | 2 +- docs/spec/_category_.json | 2 +- x/README.md | 12 +++++++-- 9 files changed, 22 insertions(+), 52 deletions(-) delete mode 100644 docs/docs/ecosystem/README.md delete mode 100644 docs/docs/ecosystem/_category_.json diff --git a/docs/docs/README.md b/docs/docs/README.md index 358154e93989..451a0bc1942e 100644 --- a/docs/docs/README.md +++ b/docs/docs/README.md @@ -32,6 +32,6 @@ Check out the docs for the various parts of the Cosmos stack. ## Help & Support +* [**GitHub Discussions**](https://github.com/orgs/cosmos/discussions) - Ask questions and discuss SDK development on GitHub. * [**Discord**](https://discord.gg/cosmosnetwork) - Chat with Cosmos developers on Discord. -* [**GitHub Discussions**](https://github.com/cosmos/cosmos-sdk/discussions) - Ask questions and discuss SDK development on GitHub. * [**Found an issue?**](https://github.com/cosmos/cosmos-sdk/edit/main/docs/docs/README.md) - Help us improve this page by suggesting edits on GitHub. diff --git a/docs/docs/ecosystem/README.md b/docs/docs/ecosystem/README.md deleted file mode 100644 index 488203cd8db1..000000000000 --- a/docs/docs/ecosystem/README.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Ecosystem - -This section highlights some of the cosmos ecosystem tooling and where to find it. - -## IBC - -See the official [`ibc-go` documentation](https://ibc.cosmos.network). - -### `x/capability` - -The capability module was once a Cosmos SDK module. From SDK v0.48, this module is maintained by the IBC team. -Find out more on their [repository](https://github.com/cosmos/ibc-go/tree/fdd664698d79864f1e00e147f9879e58497b5ef1/modules/capability). - -## CosmWasm smart contracts - ->CosmWasm is a smart contracting platform built for the Cosmos ecosystem. Simply put, it's the Cosmos (Cosm) way of using WebAssembly (Wasm) hence the name. - ->CosmWasm is written as a module that can plug into the Cosmos SDK. This means that anyone currently building a blockchain using the Cosmos SDK can quickly and easily add CosmWasm smart contracting support to their chain, without adjusting existing logic. - -Read more about writing smart contracts with CosmWasm at their [documentation site](https://book.cosmwasm.com/), or visit [the repository](https://github.com/CosmWasm/cosmwasm). - -## EVM - -Read more about writing smart contracts with solidity at the official [`evm` documentation page](https://docs.evmos.org/modules/evm/). - -## Explore Further - -:::tip -For non Cosmos SDK related tooling, you can have a look at the [Awesome Cosmos](https://github.com/cosmos/awesome-cosmos) GitHub repository. -::: - -:::note -If you would like to add your tooling to this section, please make a [PR to the Cosmos SDK](https://github.com/cosmos/cosmos-sdk/edit/main/docs/docs/ecosystem/README.md). -::: diff --git a/docs/docs/ecosystem/_category_.json b/docs/docs/ecosystem/_category_.json deleted file mode 100644 index 4e6d0facbb25..000000000000 --- a/docs/docs/ecosystem/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Ecosystem", - "position": 8, - "link": null -} \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 631ebd6c29c7..9d5007d122c5 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -386,8 +386,8 @@ const config = { to: "/main/modules/upgrade/", }, { - from: ["/main/modules/capability"], - to: "/main/ecosystem", + from: ["/main/modules/capability", "/main/ecosystem"], + to: "/main/modules", }, { from: ["/main/spec/circuit-breaker"], diff --git a/docs/rfc/_category_.json b/docs/rfc/_category_.json index cff77f85f0b4..40fac9822465 100644 --- a/docs/rfc/_category_.json +++ b/docs/rfc/_category_.json @@ -1,5 +1,5 @@ { "label": "RFCs", - "position": 13, + "position": 12, "link": null } \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index 45531a226f33..9c832f8144d6 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -37,10 +37,15 @@ const sidebars = { label: "REST API Spec", href: "https://docs.cosmos.network/swagger/", }, + { + type: "link", + label: "Awesome Cosmos", + href: "https://github.com/cosmos/awesome-cosmos", + }, { type: "link", label: "Support", - href: "https://discord.gg/cosmosnetwork", + href: "https://github.com/orgs/cosmos/discussions", }, ], }, diff --git a/docs/spec/README.md b/docs/spec/README.md index 3aec9229775e..91f347a8e628 100644 --- a/docs/spec/README.md +++ b/docs/spec/README.md @@ -17,7 +17,7 @@ block. ## Modules specifications -Go the [module directory](https://github.com/cosmos/cosmos-sdk/blob/main/x/README.md) +Go the [module directory](https://docs.cosmos.network/main/modules) ## CometBFT diff --git a/docs/spec/_category_.json b/docs/spec/_category_.json index ebc04138332c..1143a00a1d4a 100644 --- a/docs/spec/_category_.json +++ b/docs/spec/_category_.json @@ -1,5 +1,5 @@ { "label": "Specifications", - "position": 12, + "position": 13, "link": null } \ No newline at end of file diff --git a/x/README.md b/x/README.md index 336601ff4de1..25b39dcb8fdb 100644 --- a/x/README.md +++ b/x/README.md @@ -29,8 +29,16 @@ To learn more about the process of building modules, visit the [building modules ## IBC -The IBC module for the SDK has moved to its [own repository](https://github.com/cosmos/ibc-go). +The IBC module for the SDK is maintained by the IBC Go team in its [own repository](https://github.com/cosmos/ibc-go). + +Additionally, that capability module that once a Cosmos SDK module, is from v0.48+ maintained by the IBC Go team. + +* [Capability](https://github.com/cosmos/ibc-go/tree/fdd664698d79864f1e00e147f9879e58497b5ef1/modules/capability) ## CosmWasm -The CosmWasm module enables smart contracts, and has its [own repository](https://github.com/CosmWasm/cosmwasm) and [documentation site](https://docs.cosmwasm.com/docs). +The CosmWasm module enables smart contracts, learn more by going to their [documentation site](https://book.cosmwasm.com/), or visit [the repository](https://github.com/CosmWasm/cosmwasm). + +## EVM + +Read more about writing smart contracts with solidity at the official [`evm` documentation page](https://docs.evmos.org/modules/evm/). From 39cd8118610a39b2c0ebbe02a8150945bc1f6e9c Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Sat, 8 Apr 2023 13:01:53 +0200 Subject: [PATCH 3/3] word --- x/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/x/README.md b/x/README.md index 25b39dcb8fdb..a7d3c5bc344c 100644 --- a/x/README.md +++ b/x/README.md @@ -31,9 +31,7 @@ To learn more about the process of building modules, visit the [building modules The IBC module for the SDK is maintained by the IBC Go team in its [own repository](https://github.com/cosmos/ibc-go). -Additionally, that capability module that once a Cosmos SDK module, is from v0.48+ maintained by the IBC Go team. - -* [Capability](https://github.com/cosmos/ibc-go/tree/fdd664698d79864f1e00e147f9879e58497b5ef1/modules/capability) +Additionally, the [capability module](https://github.com/cosmos/ibc-go/tree/fdd664698d79864f1e00e147f9879e58497b5ef1/modules/capability) is from v0.48+ maintained by the IBC Go team in its [own repository](https://github.com/cosmos/ibc-go/tree/fdd664698d79864f1e00e147f9879e58497b5ef1/modules/capability). ## CosmWasm