Skip to content

Commit

Permalink
docs: simplifying categories (#15757)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt authored Apr 10, 2023
1 parent 59e5ca2 commit 1078369
Show file tree
Hide file tree
Showing 14 changed files with 71 additions and 110 deletions.
2 changes: 1 addition & 1 deletion docs/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
38 changes: 0 additions & 38 deletions docs/docs/ecosystem/README.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs/ecosystem/_category_.json

This file was deleted.

12 changes: 10 additions & 2 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion docs/rfc/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "RFCs",
"position": 13,
"position": 12,
"link": null
}
7 changes: 6 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion docs/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/spec/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Specifications",
"position": 12,
"position": 13,
"link": null
}
16 changes: 0 additions & 16 deletions docs/spec/circuit-breaker/README.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/spec/reserve-pool/README.md

This file was deleted.

47 changes: 23 additions & 24 deletions docs/spec/store/interblock-cache.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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).
29 changes: 15 additions & 14 deletions tools/cosmovisor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 8 additions & 2 deletions x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,14 @@ 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, 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

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/).
5 changes: 5 additions & 0 deletions x/distribution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1078369

Please sign in to comment.