docs: improve usage of :::note (#17132)

cosmos · Jul 26, 2023 · 2c5f36c · 2c5f36c
1 parent fa4d87e
commit 2c5f36c
Show file tree

Hide file tree

Showing 31 changed files with 31 additions and 92 deletions.
diff --git a/docs/docs/basics/01-tx-lifecycle.md b/docs/docs/basics/01-tx-lifecycle.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 This document describes the lifecycle of a transaction from creation to committed state changes. Transaction definition is described in a [different doc](../core/01-transactions.md). The transaction is referred to as `Tx`.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md)
 :::

diff --git a/docs/docs/basics/02-query-lifecycle.md b/docs/docs/basics/02-query-lifecycle.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 This document describes the lifecycle of a query in a Cosmos SDK application, from the user interface to application stores and back. The query is referred to as `MyQuery`.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Transaction Lifecycle](./01-tx-lifecycle.md)
 :::

diff --git a/docs/docs/basics/03-accounts.md b/docs/docs/basics/03-accounts.md
@@ -8,9 +8,8 @@ sidebar_position: 1
 This document describes the in-built account and public key system of the Cosmos SDK.
 :::
 
-:::note
+:::note Pre-requisite Readings
 
-### Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md)
 

diff --git a/docs/docs/basics/04-gas-fees.md b/docs/docs/basics/04-gas-fees.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 This document describes the default strategies to handle gas and fees within a Cosmos SDK application.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md)
 

diff --git a/docs/docs/building-apps/01-app-go-v2.md b/docs/docs/building-apps/01-app-go-v2.md
@@ -11,9 +11,7 @@ Learn more about the rationale of App Wiring in [ADR-057](../architecture/adr-05
 
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [ADR 057: App Wiring](../architecture/adr-057-app-wiring.md)
 * [Depinject Documentation](../packages/01-depinject.md)

diff --git a/docs/docs/building-apps/02-app-mempool.md b/docs/docs/building-apps/02-app-mempool.md
@@ -13,9 +13,7 @@ block building than previous versions. This change was enabled by
 [ABCI 1.0](https://github.com/cometbft/cometbft/blob/v0.37.0/spec/abci).
 Notably it introduces the `PrepareProposal` and `ProcessProposal` steps of ABCI++.
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [BaseApp](../core/00-baseapp.md)
 

diff --git a/docs/docs/building-apps/03-app-upgrade.md b/docs/docs/building-apps/03-app-upgrade.md
@@ -12,9 +12,7 @@ This document describes how to upgrade your application. If you are looking spec
 This section is currently incomplete. Track the progress of this document [here](https://github.com/cosmos/cosmos-sdk/issues/11504).
 :::
 
-:::note
-
-### Pre-requisite Reading
+:::note Pre-requisite Readings
 
 * [`x/upgrade` Documentation](https://docs.cosmos.network/main/modules/upgrade)
 

diff --git a/docs/docs/building-modules/01-intro.md b/docs/docs/building-modules/01-intro.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 Modules define most of the logic of Cosmos SDK applications. Developers compose modules together using the Cosmos SDK to build their custom application-specific blockchains. This document outlines the basic concepts behind SDK modules and how to approach module management.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK application](../basics/00-app-anatomy.md)
 * [Lifecycle of a Cosmos SDK transaction](../basics/01-tx-lifecycle.md)

diff --git a/docs/docs/building-modules/01-module-manager.md b/docs/docs/building-modules/01-module-manager.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 Cosmos SDK modules need to implement the [`AppModule` interfaces](#application-module-interfaces), in order to be managed by the application's [module manager](#module-manager). The module manager plays an important role in [`message` and `query` routing](../core/00-baseapp.md#routing), and allows application developers to set the order of execution of a variety of functions like [`BeginBlocker` and `EndBlocker`](../basics/00-app-anatomy.md#begingblocker-and-endblocker).
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Introduction to Cosmos SDK Modules](./01-intro.md)
 

diff --git a/docs/docs/building-modules/02-messages-and-queries.md b/docs/docs/building-modules/02-messages-and-queries.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 `Msg`s and `Queries` are the two primary objects handled by modules. Most of the core components defined in a module, like `Msg` services, `keeper`s and `Query` services, exist to process `message`s and `queries`.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Introduction to Cosmos SDK Modules](./01-intro.md)
 

diff --git a/docs/docs/building-modules/03-msg-services.md b/docs/docs/building-modules/03-msg-services.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 A Protobuf `Msg` service processes [messages](./02-messages-and-queries.md#messages). Protobuf `Msg` services are specific to the module in which they are defined, and only process messages defined within the said module. They are called from `BaseApp` during [`DeliverTx`](../core/00-baseapp.md#delivertx).
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Module Manager](./01-module-manager.md)
 * [Messages and Queries](./02-messages-and-queries.md)

diff --git a/docs/docs/building-modules/04-query-services.md b/docs/docs/building-modules/04-query-services.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 A Protobuf Query service processes [`queries`](./02-messages-and-queries.md#queries). Query services are specific to the module in which they are defined, and only process `queries` defined within said module. They are called from `BaseApp`'s [`Query` method](../core/00-baseapp.md#query).
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Module Manager](./01-module-manager.md)
 * [Messages and Queries](./02-messages-and-queries.md)

diff --git a/docs/docs/building-modules/05-beginblock-endblock.md b/docs/docs/building-modules/05-beginblock-endblock.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 `BeginBlocker` and `EndBlocker` are optional methods module developers can implement in their module. They will be triggered at the beginning and at the end of each block respectively, when the [`BeginBlock`](../core/00-baseapp.md#beginblock) and [`EndBlock`](../core/00-baseapp.md#endblock) ABCI messages are received from the underlying consensus engine.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Module Manager](./01-module-manager.md)
 

diff --git a/docs/docs/building-modules/06-keeper.md b/docs/docs/building-modules/06-keeper.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 `Keeper`s refer to a Cosmos SDK abstraction whose role is to manage access to the subset of the state defined by various modules. `Keeper`s are module-specific, i.e. the subset of state defined by a module can only be accessed by a `keeper` defined in said module. If a module needs to access the subset of state defined by another module, a reference to the second module's internal `keeper` needs to be passed to the first one. This is done in `app.go` during the instantiation of module keepers.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Introduction to Cosmos SDK Modules](./01-intro.md)
 

diff --git a/docs/docs/building-modules/07-invariants.md b/docs/docs/building-modules/07-invariants.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 An invariant is a property of the application that should always be true. In the context of the Cosmos SDK, an `Invariant` is a function that checks for a particular invariant. These functions are useful to detect bugs early on and act upon them to limit their potential consequences (e.g. by halting the chain). They are also useful in the development process of the application to detect bugs via simulations.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Keepers](./06-keeper.md)
 

diff --git a/docs/docs/building-modules/08-genesis.md b/docs/docs/building-modules/08-genesis.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 Modules generally handle a subset of the state and, as such, they need to define the related subset of the genesis file as well as methods to initialize, verify and export it.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Module Manager](./01-module-manager.md)
 * [Keepers](./06-keeper.md)

diff --git a/docs/docs/building-modules/09-module-interfaces.md b/docs/docs/building-modules/09-module-interfaces.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 This document details how to build CLI and REST interfaces for a module. Examples from various Cosmos SDK modules are included.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Building Modules Intro](./01-intro.md)
 

diff --git a/docs/docs/building-modules/10-autocli.md b/docs/docs/building-modules/10-autocli.md
@@ -9,9 +9,7 @@ sidebar_position: 1
 This document details how to build CLI and REST interfaces for a module. Examples from various Cosmos SDK modules are included.
 :::
 
-:::note
-
-## Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Building Modules Intro](./01-intro.md)
 

diff --git a/docs/docs/building-modules/13-upgrade.md b/docs/docs/building-modules/13-upgrade.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 [In-Place Store Migrations](../core/15-upgrade.md) allow your modules to upgrade to new versions that include breaking changes. This document outlines how to build modules to take advantage of this functionality.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [In-Place Store Migration](../core/15-upgrade.md)
 

diff --git a/docs/docs/building-modules/14-simulator.md b/docs/docs/building-modules/14-simulator.md
@@ -4,9 +4,7 @@ sidebar_position: 1
 
 # Module Simulation
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Cosmos Blockchain Simulator](../core/12-simulation.md)
 :::

diff --git a/docs/docs/building-modules/15-depinject.md b/docs/docs/building-modules/15-depinject.md
@@ -4,9 +4,7 @@ sidebar_position: 1
 
 # Modules depinject-ready
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Depinject Documentation](../packages/01-depinject.md)
 

diff --git a/docs/docs/core/00-baseapp.md b/docs/docs/core/00-baseapp.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 This document describes `BaseApp`, the abstraction that implements the core functionalities of a Cosmos SDK application.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK application](../basics/00-app-anatomy.md)
 * [Lifecycle of a Cosmos SDK transaction](../basics/01-tx-lifecycle.md)

diff --git a/docs/docs/core/01-transactions.md b/docs/docs/core/01-transactions.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 `Transactions` are objects created by end-users to trigger state changes in the application.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK Application](../basics/00-app-anatomy.md)
 

diff --git a/docs/docs/core/02-context.md b/docs/docs/core/02-context.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 The `context` is a data structure intended to be passed from function to function that carries information about the current state of the application. It provides access to a branched storage (a safe branch of the entire state) as well as useful objects and information like `gasMeter`, `block height`, `consensus parameters` and more.
 :::
 
-:::note
-
-### Pre-requisites Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK Application](../basics/00-app-anatomy.md)
 * [Lifecycle of a Transaction](../basics/01-tx-lifecycle.md)

diff --git a/docs/docs/core/03-node.md b/docs/docs/core/03-node.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 The main endpoint of a Cosmos SDK application is the daemon client, otherwise known as the full-node client. The full-node runs the state-machine, starting from a genesis file. It connects to peers running the same client in order to receive and relay transactions, block proposals and signatures. The full-node is constituted of the application, defined with the Cosmos SDK, and of a consensus engine connected to the application via the ABCI.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of an SDK application](../basics/00-app-anatomy.md)
 

diff --git a/docs/docs/core/04-store.md b/docs/docs/core/04-store.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 A store is a data structure that holds the state of the application.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK application](../basics/00-app-anatomy.md)
 

diff --git a/docs/docs/core/05-encoding.md b/docs/docs/core/05-encoding.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 While encoding in the Cosmos SDK used to be mainly handled by `go-amino` codec, the Cosmos SDK is moving towards using `gogoprotobuf` for both state and client-side encoding.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK application](../basics/00-app-anatomy.md)
 

diff --git a/docs/docs/core/08-events.md b/docs/docs/core/08-events.md
@@ -7,9 +7,7 @@ sidebar_position: 1
 `Event`s are objects that contain information about the execution of the application. They are mainly used by service providers like block explorers and wallet to track the execution of various messages and index transactions.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK application](../basics/00-app-anatomy.md)
 * [CometBFT Documentation on Events](https://docs.cometbft.com/v0.37/spec/abci/abci++_basic_concepts#events)

diff --git a/docs/docs/run-node/01-run-node.md b/docs/docs/run-node/01-run-node.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 Now that the application is ready and the keyring populated, it's time to see how to run the blockchain node. In this section, the application we are running is called [`simapp`](https://github.com/cosmos/cosmos-sdk/tree/main/simapp), and its corresponding CLI binary `simd`.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Anatomy of a Cosmos SDK Application](../basics/00-app-anatomy.md)
 * [Setting up the keyring](./00-keyring.md)

diff --git a/docs/docs/run-node/02-interact-node.md b/docs/docs/run-node/02-interact-node.md
@@ -8,9 +8,7 @@ sidebar_position: 1
 There are multiple ways to interact with a node: using the CLI, using gRPC or using the REST endpoints.
 :::
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [gRPC, REST and CometBFT Endpoints](../core/06-grpc_rest.md)
 * [Running a Node](./01-run-node.md)

diff --git a/x/auth/tx/README.md b/x/auth/tx/README.md
@@ -4,9 +4,7 @@ sidebar_position: 1
 
 # `x/auth/tx`
 
-:::note
-
-### Pre-requisite Readings
+:::note Pre-requisite Readings
 
 * [Transactions](https://docs.cosmos.network/main/core/transactions#transaction-generation)
 * [Encoding](https://docs.cosmos.network/main/core/encoding#transaction-encoding)