docs: simplifying categories (#15757)

2023-04-10 13:19:57 +02:00
parent 59e5ca20b6
commit 107836964d
14 changed files with 71 additions and 110 deletions
@@ -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.
@@ -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). 
-:::
@@ -1,5 +0,0 @@
-{
-    "label": "Ecosystem",
-    "position": 8,
-    "link": null
-}
@@ -386,8 +386,16 @@ 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"],
+            to: "/main/modules/circuit",
+          },
+          {
+            from: ["/main/spec/reserve-pool"],
+            to: "/main/modules/distribution",
          },
          {
            from: ["/main/run-node/cosmovisor"],
@@ -1,5 +1,5 @@
 {
  "label": "RFCs",
-  "position": 13,
+  "position": 12,
  "link": null
 }
@@ -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",
        },
      ],
    },
@@ -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

@@ -1,5 +1,5 @@
 {
    "label": "Specifications",
-    "position": 12,
+    "position": 13,
    "link": 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.
@@ -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.
@@ -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).
+All content herein is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).