-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Fix all broken links #20204
chore: Fix all broken links #20204
Changes from 6 commits
ac93610
1ad41a6
5cdc741
9604ce3
8fc839d
912618b
d1a5064
99dfbf3
1325913
620a68f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -6,15 +6,15 @@ sidebar_position: 1 | |||||||||||||
|
||||||||||||||
:::note Synopsis | ||||||||||||||
|
||||||||||||||
The Cosmos SDK allows much easier wiring of an `app.go` thanks to App Wiring and [`depinject`](../packages/01-depinject.md). | ||||||||||||||
Learn more about the rationale of App Wiring in [ADR-057](../architecture/adr-057-app-wiring.md). | ||||||||||||||
The Cosmos SDK allows much easier wiring of an `app.go` thanks to App Wiring and [`depinject`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md). | ||||||||||||||
Learn more about the rationale of App Wiring in [ADR-057](../../architecture/adr-057-app-wiring.md). | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the spelling of "depinject" to maintain consistency. - The Cosmos SDK allows much easier wiring of an `app.go` thanks to App Wiring and [`depinject`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md).
+ The Cosmos SDK allows much easier wiring of an `app.go` thanks to App Wiring and [`Depinject`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md). Committable suggestion
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ensure consistency in the documentation of ADR-057. - Learn more about the rationale of App Wiring in [ADR-057](../../architecture/adr-057-app-wiring.md).
+ Learn more about the rationale of App Wiring in [ADR-057](../../architecture/adr-057-app-wiring.md). Committable suggestion
Suggested change
|
||||||||||||||
|
||||||||||||||
::: | ||||||||||||||
|
||||||||||||||
:::note Pre-requisite Readings | ||||||||||||||
|
||||||||||||||
* [ADR 057: App Wiring](../architecture/adr-057-app-wiring.md) | ||||||||||||||
* [Depinject Documentation](../packages/01-depinject.md) | ||||||||||||||
* [ADR 057: App Wiring](../../architecture/adr-057-app-wiring.md) | ||||||||||||||
* [Depinject Documentation](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md) | ||||||||||||||
* [Modules depinject-ready](../building-modules/15-depinject.md) | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the spelling of "depinject" to maintain consistency. - * [Depinject Documentation](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md)
+ * [Depinject Documentation](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-Depinject.md) Committable suggestion
Suggested change
|
||||||||||||||
|
||||||||||||||
::: | ||||||||||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -19,7 +19,7 @@ A Protobuf `Msg` service processes [messages](./02-messages-and-queries.md#messa | |||||
|
||||||
Each module should define a Protobuf `Msg` service, which will be responsible for processing requests (implementing `sdk.Msg`) and returning responses. | ||||||
|
||||||
As further described in [ADR 031](../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code. | ||||||
As further described in [ADR 031](../../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clarify the documentation on ADR 031. - As further described in [ADR 031](../../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code.
+ As further described in [ADR 031](../../architecture/adr-031-msg-service.md), this approach has the advantage of clearly specifying return types and generating server and client code. Committable suggestion
Suggested change
|
||||||
|
||||||
Protobuf generates a `MsgServer` interface based on a definition of `Msg` service. It is the role of the module developer to implement this interface, by implementing the state transition logic that should happen upon receival of each `sdk.Msg`. As an example, here is the generated `MsgServer` interface for `x/bank`, which exposes two `sdk.Msg`s: | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -89,6 +89,6 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/proto/cosmos/auth/v1be | |||||
``` | ||||||
|
||||||
<!-- markdown-link-check-disable --> | ||||||
gRPC gateway is started in-process along with the application and CometBFT. It can be enabled or disabled by setting gRPC Configuration `enable` in [`app.toml`](../run-node/01-run-node.md#configuring-the-node-using-apptoml-and-configtoml). | ||||||
gRPC gateway is started in-process along with the application and CometBFT. It can be enabled or disabled by setting gRPC Configuration `enable` in [`app.toml`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/user/run-node/01-run-node.md#configuring-the-node-using-apptoml-and-configtoml). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clarify the sentence structure for better readability. - gRPC gateway is started in-process along with the application and CometBFT.
+ The gRPC gateway is started in-process along with the application and CometBFT. Committable suggestion
Suggested change
|
||||||
|
||||||
The Cosmos SDK provides a command for generating [Swagger](https://swagger.io/) documentation (`protoc-gen-swagger`). Setting `swagger` in [`app.toml`](../run-node/01-run-node.md#configuring-the-node-using-apptoml-and-configtoml) defines if swagger documentation should be automatically registered. | ||||||
The Cosmos SDK provides a command for generating [Swagger](https://swagger.io/) documentation (`protoc-gen-swagger`). Setting `swagger` in [`app.toml`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/user/run-node/01-run-node.md#configuring-the-node-using-apptoml-and-configtoml) defines if swagger documentation should be automatically registered. |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -83,7 +83,7 @@ x/{module_name} | |||||
* `abci.go`: The module's `BeginBlocker` and `EndBlocker` implementations (this file is only required if `BeginBlocker` and/or `EndBlocker` need to be defined). | ||||||
* `autocli.go`: The module [autocli](https://docs.cosmos.network/main/core/autocli) options. | ||||||
* `simulation/`: The module's [simulation](./14-simulator.md) package defines functions used by the blockchain simulator application (`simapp`). | ||||||
* `README.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_MODULE.md). | ||||||
* `README.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_MODULE.md). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update the link to point to the correct location. - Learn more how to write module specs in the [spec guidelines](../../spec/SPEC_MODULE.md).
+ Learn more about how to write module specs in the [spec guidelines](../../spec/SPEC_MODULE.md). Committable suggestion
Suggested change
|
||||||
* The root directory includes type definitions for messages, events, and genesis state, including the type definitions generated by Protocol Buffers. | ||||||
* `codec.go`: The module's registry methods for interface types. | ||||||
* `errors.go`: The module's sentinel errors. | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -62,4 +62,4 @@ func (m Migrator) Migrate1to2(ctx sdk.Context) error { | |||||
} | ||||||
``` | ||||||
|
||||||
To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). For context, this code introduced migrations of the bank store that updated addresses to be prefixed by their length in bytes as outlined in [ADR-028](../architecture/adr-028-public-key-addresses.md). | ||||||
To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). For context, this code introduced migrations of the bank store that updated addresses to be prefixed by their length in bytes as outlined in [ADR-028](../../architecture/adr-028-public-key-addresses.md). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the spelling mistake in the link text. - To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76).
+ To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). Committable suggestion
Suggested change
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -86,7 +86,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/tests/integration/bank | |||||
|
||||||
## Simulations | ||||||
|
||||||
Simulations uses as well a minimal application, built with [`depinject`](../packages/01-depinject.md): | ||||||
Simulations uses as well a minimal application, built with [`depinject`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md): | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the spelling of "depinject" to maintain consistency. - Simulations uses as well a minimal application, built with [`depinject`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md):
+ Simulations use as well a minimal application, built with [`Depinject`](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md): Committable suggestion
Suggested change
|
||||||
|
||||||
:::note | ||||||
You can as well use the `AppConfig` `configurator` for creating an `AppConfig` [inline](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/slashing/app_test.go#L54-L62). There is no difference between those two ways, use whichever you prefer. | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,12 +20,12 @@ For more information on SDK tooling, see the [Tooling](https://docs.cosmos.netwo | |
|
||
## State Management | ||
|
||
* [Collections](./02-collections.md) - State management library | ||
* [ORM](./03-orm.md) - State management library | ||
* [Collections](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/02-collections.md) - State management library | ||
* [ORM](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/03-orm.md) - State management library | ||
|
||
## Automation | ||
|
||
* [Depinject](./01-depinject.md) - Dependency injection framework | ||
* [Depinject](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/01-depinject.md) - Dependency injection framework | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Possible spelling mistake in the tool name "Depinject". It seems like "Depinject" might be a typo. Please verify the correct name of the tool. If it is indeed a typo, consider correcting it to the intended name. |
||
* [Client/v2](https://pkg.go.dev/cosmossdk.io/client/v2) - Library powering [AutoCLI](https://docs.cosmos.network/main/core/autocli) | ||
|
||
## Utilities | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,9 +9,9 @@ This includes tools for development, operating a node, and ease of use of a Cosm | |
|
||
## CLI Tools | ||
|
||
* [Cosmovisor](./01-cosmovisor.md) | ||
* [Confix](./02-confix.md) | ||
* [Hubl](./03-hubl.md) | ||
* [Cosmovisor](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/tooling/01-cosmovisor.md) | ||
* [Confix](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/tooling/02-confix.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Possible spelling mistake in the tool name "Confix". It seems like "Confix" might be a typo. Please verify the correct name of the tool. If it is indeed a typo, consider correcting it to the intended name. |
||
* [Hubl](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/tooling/03-hubl.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Possible spelling mistake in the tool name "Hubl". It seems like "Hubl" might be a typo. Please verify the correct name of the tool. If it is indeed a typo, consider correcting it to the intended name. |
||
* [Rosetta](https://docs.cosmos.network/main/run-node/rosetta) | ||
|
||
## Other Tools | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,4 +93,4 @@ Upon starting, the node will bootstrap its RPC and P2P server and start dialing | |
|
||
## Other commands | ||
<!-- markdown-link-check-disable-next-line --> | ||
To discover how to concretely run a node and interact with it, please refer to our [Running a Node, API and CLI](../../user/run-node/01-run-node.md#configuring-the-node-using-apptoml-and-configtoml) guide. | ||
To discover how to concretely run a node and interact with it, please refer to our [Running a Node, API and CLI](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/user/run-node/01-run-node.md#configuring-the-node-using-apptoml-and-configtoml) guide. | ||
sontrinh16 marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we should leave the direct linking since this is used in the docs page. This will send users to the repo which is not desired There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sure I will revert this. However, a lot of file paths are not there anymore (ex. docs/user/run-node/01-run-node.md) so we still need other ways to fix this |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -47,7 +47,7 @@ via Protobuf. This means that modules may use Protobuf encoding, but the types m | |||||
implement `ProtoMarshaler`. If modules wish to avoid implementing this interface | ||||||
for their types, this is autogenerated via [buf](https://buf.build/) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the unpaired bracket to ensure proper formatting. - this is autogenerated via [buf](https://buf.build/)
+ this is autogenerated via [buf](https://buf.build/) Committable suggestion
Suggested change
|
||||||
|
||||||
If modules use [Collections](../../build/packages/02-collections.md) or [ORM](../../build/packages/03-orm.md), encoding and decoding are handled, marshal and unmarshal should not be handled manually unless for specific cases identified by the developer. | ||||||
If modules use [Collections](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/02-collections.md) or [ORM](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/packages/03-orm.md), encoding and decoding are handled, marshal and unmarshal should not be handled manually unless for specific cases identified by the developer. | ||||||
|
||||||
```go reference | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -57,7 +57,7 @@ The following examples show how to query Events using the Cosmos SDK. | |||||
| `tx.height=23` | Query all transactions at height 23 | | ||||||
| `message.action='/cosmos.bank.v1beta1.Msg/Send'` | Query all transactions containing a x/bank `Send` [Service `Msg`](../../build/building-modules/03-msg-services.md). Note the `'`s around the value. | | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the article before a vowel sound and ensure proper punctuation around the value. - Query all transactions containing a x/bank `Send` [Service `Msg`](../../build/building-modules/03-msg-services.md). Note the `'`s around the value.
+ Query all transactions containing an x/bank `Send` [Service `Msg`](../../build/building-modules/03-msg-services.md). Note the `'`s around the value. Committable suggestion
Suggested change
|
||||||
| `message.module='bank'` | Query all transactions containing messages from the x/bank module. Note the `'`s around the value. | | ||||||
| `create_validator.validator='cosmosval1...'` | x/staking-specific Event, see [x/staking SPEC](../../build/modules/staking/README.md). | | ||||||
| `create_validator.validator='cosmosval1...'` | x/staking-specific Event, see [x/staking SPEC](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/modules/staking/README.md). | | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ensure consistent spacing in markdown tables. - | `create_validator.validator='cosmosval1...'` | x/staking-specific Event, see [x/staking SPEC](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/modules/staking/README.md).
+ | `create_validator.validator='cosmosval1...'` | x/staking-specific Event, see [x/staking SPEC](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/modules/staking/README.md). Committable suggestion
Suggested change
|
||||||
<!-- markdown-link-check-enable --> | ||||||
## EventManager | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -159,4 +159,4 @@ You can sync a full node to an existing blockchain which has been upgraded using | |
|
||
To successfully sync, you must start with the initial binary that the blockchain started with at genesis. If all Software Upgrade Plans contain binary instruction, then you can run Cosmovisor with auto-download option to automatically handle downloading and switching to the binaries associated with each sequential upgrade. Otherwise, you need to manually provide all binaries to Cosmovisor. | ||
|
||
To learn more about Cosmovisor, see the [Cosmovisor Quick Start](../../build/tooling/01-cosmovisor.md). | ||
To learn more about Cosmovisor, see the [Cosmovisor Quick Start](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/tooling/01-cosmovisor.md). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update the link to the Cosmovisor Quick Start guide. The provided link points to an outdated or incorrect URL. Please update it to the correct location on GitHub or the appropriate documentation site. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the location of
coin.ParseCoin
to reflect the PR description accurately.Committable suggestion