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
@@ -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).