Skip to content

Commit

Permalink
docs: fix broken cosmos SDK documentation links (#3677)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeronimoalbi authored Oct 2, 2023
1 parent ced08ac commit b0e1bab
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/docs/02-guide/06-ibc.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ acknowledgment.
Append the type instance as `PostID` on receiving the packet:

- The context `ctx` is an [immutable data
structure](https://docs.cosmos.network/main/core/context.html#go-context-package)
structure](https://docs.cosmos.network/main/core/context#go-context-package)
that has header data from the transaction. See [how the context is
initiated](https://github.com/cosmos/cosmos-sdk/blob/main/types/context.go#L71)
- The identifier format that you defined earlier
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/02-guide/10-simapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ simulation methods for each scaffolded message.

Every new module that is scaffolded with Ignite CLI implements the Cosmos SDK
[Module
Simulation](https://docs.cosmos.network/main/building-modules/simulator.html).
Simulation](https://docs.cosmos.network/main/building-modules/simulator).

- Each new message creates a file with the simulation methods required for the
tests.
Expand Down Expand Up @@ -105,7 +105,7 @@ according to call the function.
## Invariants

Simulating a chain can help you prevent [chain invariants
errors](https://docs.cosmos.network/main/building-modules/invariants.html). An
errors](https://docs.cosmos.network/main/building-modules/invariants). An
invariant is a function called by the chain to check if something broke,
invalidating the chain data. To create a new invariant and check the chain
integrity, you must create a method to validate the invariants and register all
Expand Down
6 changes: 3 additions & 3 deletions docs/versioned_docs/version-v0.25.2/guide/02-hello.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,12 @@ To get your blockchain to say `Hello! Ignite CLI`, you need to make these change

Protocol buffer files contain proto rpc calls that define Cosmos SDK queries and message handlers, and proto messages that define Cosmos SDK types. The rpc calls are also responsible for exposing an HTTP API.

For each Cosmos SDK module, the [Keeper](https://docs.cosmos.network/main/building-modules/keeper.html) is an abstraction for modifying the state of the blockchain. Keeper functions let you query or write to the state. After you add the first query to your chain, the next step is to register the query. You only need to register a query once.
For each Cosmos SDK module, the [Keeper](https://docs.cosmos.network/main/building-modules/keeper) is an abstraction for modifying the state of the blockchain. Keeper functions let you query or write to the state. After you add the first query to your chain, the next step is to register the query. You only need to register a query once.

A typical blockchain developer workflow looks something like this:

- Start with proto files to define Cosmos SDK [messages](https://docs.cosmos.network/main/building-modules/msg-services.html)
- Define and register [queries](https://docs.cosmos.network/main/building-modules/query-services.html)
- Start with proto files to define Cosmos SDK [messages](https://docs.cosmos.network/main/building-modules/msg-services)
- Define and register [queries](https://docs.cosmos.network/main/building-modules/query-services)
- Define message handler logic
- Finally, implement the logic of these queries and message handlers in keeper functions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This tutorial guides you through these steps to build a blockchain for a nameser
- A supported version of [Ignite CLI](/). To install Ignite CLI, see [Install Ignite CLI](../01-install.md).
* A text editor like [Visual Studio Code](https://code.visualstudio.com/download).
* A web browser like [Chrome](https://www.google.com/chrome) or [Firefox](https://www.mozilla.org/en-US/firefox/new).
- Familiarity with [Cosmos SDK modules](https://docs.cosmos.network/main/building-modules/intro.html)
- Familiarity with [Cosmos SDK modules](https://docs.cosmos.network/main/building-modules/intro)

## Nameservice App Goals

Expand Down Expand Up @@ -72,11 +72,11 @@ For your nameservice app, use one store to map a `name` key to its respective `w

## Messages

In the Cosmos SDK, [messages](https://docs.cosmos.network/main/building-modules/messages-and-queries.html#messages) are objects that are contained in transactions to trigger state transitions. Each Cosmos SDK module defines a list of messages and how to handle them.
In the Cosmos SDK, [messages](https://docs.cosmos.network/main/building-modules/messages-and-queries#messages) are objects that are contained in transactions to trigger state transitions. Each Cosmos SDK module defines a list of messages and how to handle them.

You must create [messages for the nameservice module](./02-messages.md) that support this functionality:

- When a transaction that is included in a block reaches a Tendermint node, the transaction is passed to the application using the Application Blockchain Interface [(ABCI)](https://docs.cosmos.network/main/intro/sdk-app-architecture.html#abci) between Tendermint and your app.
- When a transaction that is included in a block reaches a Tendermint node, the transaction is passed to the application using the Application Blockchain Interface [(ABCI)](https://docs.cosmos.network/main/intro/sdk-app-architecture#abci) between Tendermint and your app.
- The transaction is decoded to get the message.
- The message is then routed to the appropriate module and handled according to the logic defined in the corresponding `Handler`.
- If the state needs to be updated, the `Handler` calls the `Keeper` to perform the update.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Define keepers for the nameservice module.

# Keeper

> The main core of a Cosmos SDK module is a piece called the keeper. The keeper handles interactions with the store, has references to other [keepers](https://docs.cosmos.network/main/building-modules/keeper.html) for cross-module interactions, and contains most of the core functionality of a module.
> The main core of a Cosmos SDK module is a piece called the keeper. The keeper handles interactions with the store, has references to other [keepers](https://docs.cosmos.network/main/building-modules/keeper) for cross-module interactions, and contains most of the core functionality of a module.
## Define Keepers for the Nameservice Module

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.25.2/guide/07-ibc.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ Finally, the Ignite CLI-generated AppendPost function returns the ID of the new

Append the type instance as `PostID` on receiving the packet:

- The context `ctx` is an [immutable data structure](https://docs.cosmos.network/main/core/context.html#go-context-package) that has header data from the transaction. See [how the context is initiated](https://github.com/cosmos/cosmos-sdk/blob/master/types/context.go#L71)
- The context `ctx` is an [immutable data structure](https://docs.cosmos.network/main/core/context#go-context-package) that has header data from the transaction. See [how the context is initiated](https://github.com/cosmos/cosmos-sdk/blob/master/types/context.go#L71)
- The identifier format that you defined earlier
- The `title` is the Title of the blog post
- The `content` is the Content of the blog post
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.25.2/kb/02-serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ build:
ldflags: [ "-X main.Env=prod", "-X main.Version=1.0.1" ]
```

Learn more about how to use the binary to [run a chain in production](https://docs.cosmos.network/main/run-node/run-node.html).
Learn more about how to use the binary to [run a chain in production](https://docs.cosmos.network/main/run-node/run-node).
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.25.2/kb/11-simapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Ignite CLI chain simulator can help you to run your chain based in randomize

## Module simulation

Every new module that is scaffolded with Ignite CLI implements the Cosmos SDK [Module Simulation](https://docs.cosmos.network/main/building-modules/simulator.html).
Every new module that is scaffolded with Ignite CLI implements the Cosmos SDK [Module Simulation](https://docs.cosmos.network/main/building-modules/simulator).

- Each new message creates a file with the simulation methods required for the tests.
- Scaffolding a `CRUD` type like a `list` or `map` creates a simulation file with `create`, `update`, and `delete` simulation methods in the `x/<module>/simulation` folder and registers these methods in `x/<module>/module_simulation.go`.
Expand Down Expand Up @@ -80,7 +80,7 @@ After the parameters are scaffolded, change the `x/<module>/module_simulation.go

## Invariants

Simulating a chain can help you prevent [chain invariants errors](https://docs.cosmos.network/main/building-modules/invariants.html). An invariant is a function called by the chain to check if something broke, invalidating the chain data.
Simulating a chain can help you prevent [chain invariants errors](https://docs.cosmos.network/main/building-modules/invariants). An invariant is a function called by the chain to check if something broke, invalidating the chain data.
To create a new invariant and check the chain integrity, you must create a method to validate the invariants and register all invariants.

For example, in `x/earth/keeper/invariants.go`:
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.26.1/02-guide/06-ibc.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ acknowledgment.
Append the type instance as `PostID` on receiving the packet:

- The context `ctx` is an [immutable data
structure](https://docs.cosmos.network/main/core/context.html#go-context-package)
structure](https://docs.cosmos.network/main/core/context#go-context-package)
that has header data from the transaction. See [how the context is
initiated](https://github.com/cosmos/cosmos-sdk/blob/main/types/context.go#L71)
- The identifier format that you defined earlier
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.26.1/02-guide/10-simapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ simulation methods for each scaffolded message.

Every new module that is scaffolded with Ignite CLI implements the Cosmos SDK
[Module
Simulation](https://docs.cosmos.network/main/building-modules/simulator.html).
Simulation](https://docs.cosmos.network/main/building-modules/simulator).

- Each new message creates a file with the simulation methods required for the
tests.
Expand Down Expand Up @@ -105,7 +105,7 @@ according to call the function.
## Invariants

Simulating a chain can help you prevent [chain invariants
errors](https://docs.cosmos.network/main/building-modules/invariants.html). An
errors](https://docs.cosmos.network/main/building-modules/invariants). An
invariant is a function called by the chain to check if something broke,
invalidating the chain data. To create a new invariant and check the chain
integrity, you must create a method to validate the invariants and register all
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.27.1/02-guide/06-ibc.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ acknowledgment.
Append the type instance as `PostID` on receiving the packet:

- The context `ctx` is an [immutable data
structure](https://docs.cosmos.network/main/core/context.html#go-context-package)
structure](https://docs.cosmos.network/main/core/context#go-context-package)
that has header data from the transaction. See [how the context is
initiated](https://github.com/cosmos/cosmos-sdk/blob/main/types/context.go#L71)
- The identifier format that you defined earlier
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.27.1/02-guide/10-simapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ simulation methods for each scaffolded message.

Every new module that is scaffolded with Ignite CLI implements the Cosmos SDK
[Module
Simulation](https://docs.cosmos.network/main/building-modules/simulator.html).
Simulation](https://docs.cosmos.network/main/building-modules/simulator).

- Each new message creates a file with the simulation methods required for the
tests.
Expand Down Expand Up @@ -105,7 +105,7 @@ according to call the function.
## Invariants

Simulating a chain can help you prevent [chain invariants
errors](https://docs.cosmos.network/main/building-modules/invariants.html). An
errors](https://docs.cosmos.network/main/building-modules/invariants). An
invariant is a function called by the chain to check if something broke,
invalidating the chain data. To create a new invariant and check the chain
integrity, you must create a method to validate the invariants and register all
Expand Down

0 comments on commit b0e1bab

Please sign in to comment.