Skip to content

Commit

Permalink
docs: fix ordering (#15387)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt committed Mar 14, 2023
1 parent 3513c5d commit a392bae
Show file tree
Hide file tree
Showing 12 changed files with 9 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/docs/building-modules/01-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ Modules are by convention defined in the `./x/` subfolder (e.g. the `bank` modul

In addition to these components, modules implement the `AppModule` interface in order to be managed by the [`module manager`](./01-module-manager.md).

Please refer to the [structure document](./10-structure.md) to learn about the recommended structure of a module's directory.
Please refer to the [structure document](./11-structure.md) to learn about the recommended structure of a module's directory.
Original file line number Diff line number Diff line change
Expand Up @@ -120,13 +120,13 @@ Here are some example commands that use the positional arguments we defined abov
To query an account by address:

```bash
`./app query auth account cosmos1abcd...xyz`
<appd> query auth account cosmos1abcd...xyz
```

To query an account address by account number:

```bash
`./app query auth address-by-acc-num 1`
<appd> query auth address-by-acc-num 1
```

In both of these commands, the `auth` service is being queried with the `query` subcommand, followed by the specific method being called (`account` or `address-by-acc-num`). The positional argument is included at the end of the command (`cosmos1abcd...xyz` or `1`) to specify the address or account number, respectively.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ x/{module_name}
* `keeper/`: The module's `Keeper` and `MsgServer` implementation.
* `module/`: The module's `AppModule` and `AppModuleBasic` implementation.
* `abci.go`: The module's `BeginBlocker` and `EndBlocker` implementations (this file is only required if `BeginBlocker` and/or `EndBlocker` need to be defined).
* `simulation/`: The module's [simulation](./13-simulator.md) package defines functions used by the blockchain simulator application (`simapp`).
* `simulation/`: The module's [simulation](./14-simulator.md) package defines functions used by the blockchain simulator application (`simapp`).
* `REAMDE.md`: The module's specification documents outlining important concepts, state storage structure, and message and event type definitions. Learn more how to write module specs in the [spec guidelines](../spec/SPEC-SPEC.md).
* The root directory includes type definitions for messages, events, and genesis state, including the type definitions generated by Protocol Buffers.
* `autocli.go`: The module [autocli](./09-autocli.md) options.
* `autocli.go`: The module [autocli](./10-autocli.md) options.
* `codec.go`: The module's registry methods for interface types.
* `errors.go`: The module's sentinel errors.
* `events.go`: The module's event types and constructors.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/core/12-simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,5 @@ Here are some suggestions when encountering a simulation failure:
Learn how you can integrate the simulation into your Cosmos SDK-based application:

* Application Simulation Manager
* [Building modules: Simulator](../building-modules/13-simulator.md)
* [Building modules: Simulator](../building-modules/14-simulator.md)
* Simulator tests
4 changes: 2 additions & 2 deletions docs/docs/core/15-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Cosmos SDK uses two methods to perform upgrades:

* Exporting the entire application state to a JSON file using the `export` CLI command, making changes, and then starting a new binary with the changed JSON file as the genesis file.

* Perform upgrades in place, which significantly decrease the upgrade time for chains with a larger state. Use the [Module Upgrade Guide](../building-modules/12-upgrade.md) to set up your application modules to take advantage of in-place upgrades.
* Perform upgrades in place, which significantly decrease the upgrade time for chains with a larger state. Use the [Module Upgrade Guide](../building-modules/13-upgrade.md) to set up your application modules to take advantage of in-place upgrades.

This document provides steps to use the In-Place Store Migrations upgrade method.

Expand Down Expand Up @@ -63,7 +63,7 @@ app.UpgradeKeeper.SetUpgradeHandler("my-plan", func(ctx sdk.Context, plan upgrad
})
```

To learn more about configuring migration scripts for your modules, see the [Module Upgrade Guide](../building-modules/12-upgrade.md).
To learn more about configuring migration scripts for your modules, see the [Module Upgrade Guide](../building-modules/13-upgrade.md).

### Order Of Migrations

Expand Down
5 changes: 0 additions & 5 deletions docs/docs/pkg/_category_.json

This file was deleted.

2 changes: 1 addition & 1 deletion docs/rfc/_category.json → docs/rfc/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
"label": "RFCs",
"position": 12,
"link": null
}
}

0 comments on commit a392bae

Please sign in to comment.