From b1208ef298ec4272318da33cff9ce761907bcd1f Mon Sep 17 00:00:00 2001 From: samricotta <37125168+samricotta@users.noreply.github.com> Date: Tue, 19 Sep 2023 13:48:03 +0300 Subject: [PATCH] docs: link correction for docs (#17799) Co-authored-by: marbar3778 --- docs/docs/build/building-modules/06-keeper.md | 2 +- docs/docs/develop/intro/{00-overview.md => 00-what-is-sdk.md} | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) rename docs/docs/develop/intro/{00-overview.md => 00-what-is-sdk.md} (98%) diff --git a/docs/docs/build/building-modules/06-keeper.md b/docs/docs/build/building-modules/06-keeper.md index 45143323d9fc..8d8a0a9dae88 100644 --- a/docs/docs/build/building-modules/06-keeper.md +++ b/docs/docs/build/building-modules/06-keeper.md @@ -48,7 +48,7 @@ Let us go through the different parameters: * An expected `keeper` is a `keeper` external to a module that is required by the internal `keeper` of said module. External `keeper`s are listed in the internal `keeper`'s type definition as interfaces. These interfaces are themselves defined in an `expected_keepers.go` file in the root of the module's folder. In this context, interfaces are used to reduce the number of dependencies, as well as to facilitate the maintenance of the module itself. * `storeKey`s grant access to the store(s) of the [multistore](../../develop/advanced/04-store.md) managed by the module. They should always remain unexposed to external modules. -* `cdc` is the [codec](../develop/advanced/05-encoding.md) used to marshall and unmarshall structs to/from `[]byte`. The `cdc` can be any of `codec.BinaryCodec`, `codec.JSONCodec` or `codec.Codec` based on your requirements. It can be either a proto or amino codec as long as they implement these interfaces. The authority listed is a module account or user account that has the right to change module level parameters. Previously this was handled by the param module, which has been deprecated. +* `cdc` is the [codec](../../build/develop/advanced/05-encoding.md) used to marshall and unmarshall structs to/from `[]byte`. The `cdc` can be any of `codec.BinaryCodec`, `codec.JSONCodec` or `codec.Codec` based on your requirements. It can be either a proto or amino codec as long as they implement these interfaces. The authority listed is a module account or user account that has the right to change module level parameters. Previously this was handled by the param module, which has been deprecated. Of course, it is possible to define different types of internal `keeper`s for the same module (e.g. a read-only `keeper`). Each type of `keeper` comes with its own constructor function, which is called from the [application's constructor function](../../develop/beginner/00-app-anatomy.md). This is where `keeper`s are instantiated, and where developers make sure to pass correct instances of modules' `keeper`s to other modules that require them. diff --git a/docs/docs/develop/intro/00-overview.md b/docs/docs/develop/intro/00-what-is-sdk.md similarity index 98% rename from docs/docs/develop/intro/00-overview.md rename to docs/docs/develop/intro/00-what-is-sdk.md index 05bc63d830dc..616d3316921f 100644 --- a/docs/docs/develop/intro/00-overview.md +++ b/docs/docs/develop/intro/00-what-is-sdk.md @@ -2,9 +2,7 @@ sidebar_position: 1 --- -# High-level Overview - -## What is the Cosmos SDK +# What is the Cosmos SDK The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) is an open-source framework for building multi-asset public Proof-of-Stake (PoS) blockchains, like the Cosmos Hub, as well as permissioned Proof-of-Authority (PoA) blockchains. Blockchains built with the Cosmos SDK are generally referred to as **application-specific blockchains**.