chore: Fix all broken links #20204
chore: Fix all broken links #20204
Conversation
WalkthroughThis update primarily focuses on correcting and updating documentation links across various files in the Cosmos SDK repository. Changes include adjusting URLs to point to the correct document locations, updating file paths, and ensuring that internal references are accurate and functional. Changes
Possibly related issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
MasterPi-2124
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
Out of diff range and nitpick comments (29)
docs/build/building-apps/01-app-go-v2.md (2)
Line range hint
60-60: Correct the grammatical error in the sentence.- The configuration can then be embed with `go:embed` and read with [`appconfig.LoadYAML`](https://pkg.go.dev/cosmossdk.io/core/appconfig#LoadYAML), or [`appconfig.LoadJSON`](https://pkg.go.dev/cosmossdk.io/core/appconfig#LoadJSON), in `app_di.go`. + The configuration can then be embedded with `go:embed` and read with [`appconfig.LoadYAML`](https://pkg.go.dev/cosmossdk.io/core/appconfig#LoadYAML), or [`appconfig.LoadJSON`](https://pkg.go.dev/cosmossdk.io/core/appconfig#LoadJSON), in `app_di.go`.
Line range hint
100-100: Ensure the sentence starts with an uppercase letter.- `app_di.go` is the place where `SimApp` is constructed. + `App_di.go` is the place where `SimApp` is constructed.docs/build/building-modules/16-testing.md (2)
Line range hint
9-9: Correct the grammatical error in the sentence.- We advice, as a general rule, to use tests at all stages of the development cycle. + We advise, as a general rule, to use tests at all stages of the development cycle.
Line range hint
10-10: Improve the sentence structure for clarity.- It is advised, as a chain developer, to test your application and modules in a similar way than the SDK. + It is advised, as a chain developer, to test your application and modules similarly to the SDK.docs/learn/advanced/08-events.md (2)
Line range hint
6-6: Replace accent character with an apostrophe for correct punctuation.- `Event`s are objects that contain information about the execution of the application. + `Event's` are objects that contain information about the execution of the application.
Line range hint
28-28: Replace accent character with an apostrophe for correct punctuation.- A list of `attributes` are key-value pairs that give more information about the categorized Event. + A list of `attributes` are key-value pairs that give more information about the categorized Event's.x/authz/README.md (3)
Line range hint
9-9: Capitalize the first letter of the sentence following the header for proper sentence structure.- `x/authz` is an implementation of a Cosmos SDK module... + `X/authz` is an implementation of a Cosmos SDK module...
Line range hint
15-31: Adjust the indentation of the unordered list to maintain consistency and readability.- * [Authorization and Grant](#authorization-and-grant) - * [Built-in Authorizations](#built-in-authorizations) - * [Gas](#gas) + * [Authorization and Grant](#authorization-and-grant) + * [Built-in Authorizations](#built-in-authorizations) + * [Gas](#gas)
Line range hint
87-87: Use American English spelling for consistency across the documentation.- to authorise delegating, undelegating or redelegating + to authorize delegating, undelegating or redelegatingdocs/learn/advanced/05-encoding.md (1)
Line range hint
251-251: Correct the unpaired bracket to ensure proper formatting.- see more details in [ADR 023](../../architecture/adr-023-protobuf-naming.md) + see more details in [ADR 023](../../architecture/adr-023-protobuf-naming.md)docs/learn/advanced/07-cli.md (6)
Line range hint
8-8: Consider adding the article "the" before "command-line interface" for grammatical correctness.
Line range hint
8-8: Replace "on" with "at" to correct the preposition usage: "works at a high-level".
Line range hint
36-36: Ensure that bullet points start with an uppercase letter for consistency and readability.
Line range hint
53-53: Add a space after the period to separate sentences properly for better readability.
167-167: Consider adding the article "the" before "flags" to maintain grammatical consistency.
Line range hint
196-196: Add a space after the period to separate sentences properly for better readability.x/auth/README.md (2)
Line range hint
21-31: Correct the indentation for unordered lists to improve readability.- * `auth` - authentication of accounts and transactions for Cosmos SDK applications and is responsible for specifying the base transaction and account types. - * `authz` - authorization for accounts to perform actions on behalf of other accounts and enables a granter to grant authorizations to a grantee that allows the grantee to execute messages on behalf of the granter. + * `auth` - authentication of accounts and transactions for Cosmos SDK applications and is responsible for specifying the base transaction and account types. + * `authz` - authorization for accounts to perform actions on behalf of other accounts and enables a granter to grant authorizations to a grantee that allows the grantee to execute messages on behalf of the granter.
Line range hint
432-432: Remove trailing spaces to adhere to Markdown best practices.- When adding transactions to mempool or gossipping transactions, validators check if the transaction's gas prices, which are determined by the provided fees, meet any of the validator's minimum gas prices. In other words, a transaction must provide a fee of at least one denomination that matches a validator's minimum gas price. + When adding transactions to mempool or gossipping transactions, validators check if the transaction's gas prices, which are determined by the provided fees, meet any of the validator's minimum gas prices. In other words, a transaction must provide a fee of at least one denomination that matches a validator's minimum gas price.docs/learn/beginner/00-app-anatomy.md (11)
199-199: Consider adding a space after the comma in thegrpc.enableandgrpc.addressfields for better readability.
Line range hint
55-55: Replace the accent character with an apostrophe in "module'skeepers."- **A list of module's `keeper`s.** + **A list of module's `keepers`.**
Line range hint
80-80: Replace the accent character with an apostrophe in "legacyMsgs."- The Cosmos SDK still supports legacy `Msg`s and legacy CometBFT queries, which are routed using the legacy `Msg` routes and the legacy query routes, respectively. + The Cosmos SDK still supports legacy `Msgs` and legacy CometBFT queries, which are routed using the legacy `Msg` routes and the legacy query routes, respectively.
Line range hint
182-182: Replace the accent character with an apostrophe in "ProtobufAnys."- `sdk.Msg`s are encoded using Protobuf [`Any`s](#register-codec). + `sdk.Msgs` are encoded using Protobuf [`Anys`](#register-codec).
Line range hint
168-168: Replace the accent character with an apostrophe in "other modules'keepers."- **Reference to other modules' `keeper`s.** + **Reference to other modules' `keepers`.**
Line range hint
219-219: Replace the accent character with an apostrophe in "other modules'keepers."- and potentially references other modules' `keeper`s as parameters. + and potentially references other modules' `keepers` as parameters.
Line range hint
216-216: Correct the possessive form to plural form by removing the apostrophe in "other module'skeepers."- * Reference to **other module's `keepers`**. + * Reference to **other modules' `keepers`**.
Line range hint
217-217: Consider rephrasing to avoid the comma before "because" as it introduces an essential clause.- The `keeper` needs it to marshal structs before storing them, or to unmarshal them when it retrieves them, because stores only accept `[]bytes` as value. + The `keeper` needs it to marshal structs before storing them or to unmarshal them when it retrieves them because stores only accept `[]bytes` as value.
Line range hint
81-81: Consider using "different from" instead of "different than" for more formal writing.- Should the value be different than the predicted one, special logic defined in the invariant registry is triggered (usually the chain is halted). + Should the value be different from the predicted one, special logic defined in the invariant registry is triggered (usually the chain is halted).
Line range hint
84-87: Adjust the indentation of the unordered list to match the surrounding content.- * [`InitChainer`](#initchainer): used to initialize the application when it is first started. - * [`PreBlocker`](#preblocker): called before BeginBlock. - * [`BeginBlocker`, `EndBlocker`](#beginblocker-and-endblocker): called at the beginning and at the end of every block. - * [`anteHandler`](../advanced/00-baseapp.md#antehandler): used to handle fees and signature verification. + * [`InitChainer`](#initchainer): used to initialize the application when it is first started. + * [`PreBlocker`](#preblocker): called before BeginBlock. + * [`BeginBlocker`, `EndBlocker`](#beginblocker-and-endblocker): called at the beginning and at the end of every block. + * [`anteHandler`](../advanced/00-baseapp.md#antehandler): used to handle fees and signature verification.
Line range hint
115-116: Use asterisks for list items to maintain consistency with the rest of the document.- - It runs before the `BeginBlocker` of all modules - - It can modify consensus parameters in storage, and signal the caller through the return value. + * It runs before the `BeginBlocker` of all modules + * It can modify consensus parameters in storage, and signal the caller through the return value.
docs/learn/advanced/15-upgrade.md
Outdated
| @@ -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.
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.
docs/learn/advanced/08-events.md
Outdated
| @@ -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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| | `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. | | |
| | `message.action='/cosmos.bank.v1beta1.Msg/Send'` | Query all transactions containing an x/bank `Send` [Service `Msg`](../../build/building-modules/03-msg-services.md). Note the `'`s around the value. | |
docs/learn/advanced/08-events.md
Outdated
| @@ -57,7 +57,7 @@ | |||
| | `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. | | |||
| | `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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| | `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). |
docs/build/tooling/README.md
Outdated
| * [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.
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.
docs/build/tooling/README.md
Outdated
| * [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) | ||
| * [Hubl](https://github.com/cosmos/cosmos-sdk-docs/blob/main/docs/build/tooling/03-hubl.md) |
There was a problem hiding this comment.
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.
| 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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 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). | |
| 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). |
| * [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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * [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) | |
| * [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) |
| @@ -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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 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): |
| @@ -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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 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). | |
| The 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). |
docs/learn/advanced/03-node.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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.
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
There was a problem hiding this comment.
Actionable comments posted: 6
Out of diff range and nitpick comments (19)
docs/spec/store/interblock-cache.md (3)
Line range hint
31-31: Correct grammatical error in the description of data stability.- This is data that do not change often + This is data that does not change often
Line range hint
74-74: Correct verb agreement in the description of atomic writes.- supports atomic writes and use them + supports atomic writes and uses them
Line range hint
4-265: Correct Markdown list indentation for consistency and readability.- * [Inter-block Cache](#inter-block-cache) - * [Synopsis](#synopsis) - * [Overview and basic concepts](#overview-and-basic-concepts) - * [Motivation](#motivation) - * [Definitions](#definitions) - * [System model and properties](#system-model-and-properties) - * [Assumptions](#assumptions) - * [Properties](#properties) - * [Thread safety](#thread-safety) - * [Crash recovery](#crash-recovery) - * [Iteration](#iteration) - * [Technical specification](#technical-specification) - * [General design](#general-design) - * [API](#api) - * [CommitKVCacheManager](#commitkvcachemanager) - * [CommitKVStoreCache](#commitkvstorecache) - * [Implementation details](#implementation-details) - * [History](#history) - * [Copyright](#copyright) + * [Inter-block Cache](#inter-block-cache) + * [Synopsis](#synopsis) + * [Overview and basic concepts](#overview-and-basic-concepts) + * [Motivation](#motivation) + * [Definitions](#definitions) + * [System model and properties](#system-model-and-properties) + * [Assumptions](#assumptions) + * [Properties](#properties) + * [Thread safety](#thread-safety) + * [Crash recovery](#crash-recovery) + * [Iteration](#iteration) + * [Technical specification](#technical-specification) + * [General design](#general-design) + * [API](#api) + * [CommitKVCacheManager](#commitkvcachemanager) + * [CommitKVStoreCache](#commitkvstorecache) + * [Implementation details](#implementation-details) + * [History](#history) + * [Copyright](#copyright)x/authz/README.md (7)
Line range hint
9-9: Capitalize the first letter of the sentence for proper noun consistency.- # `x/authz` + # `X/authz`
Line range hint
107-107: Add a comma after "Hence" for correct punctuation.- Hence we only allow one grant for the (granter, grantee, Authorization) triple. + Hence, we only allow one grant for the (granter, grantee, Authorization) triple.
Line range hint
152-152: Ensure sentences start with an uppercase letter.- * both granter and grantee have the same address. + * Both granter and grantee have the same address.
Line range hint
153-153: Ensure sentences start with an uppercase letter.- * provided `Expiration` time is less than current unix timestamp (but a grant will be created if no `expiration` time is provided since `expiration` is optional). + * Provided `Expiration` time is less than current unix timestamp (but a grant will be created if no `expiration` time is provided since `expiration` is optional).
Line range hint
154-154: Ensure sentences start with an uppercase letter.- * provided `Grant.Authorization` is not implemented. + * Provided `Grant.Authorization` is not implemented.
Line range hint
155-155: Ensure sentences start with an uppercase letter.- * `Authorization.MsgTypeURL()` is not defined in the router (there is no defined handler in the app router to handle that Msg types). + * `Authorization.MsgTypeURL()` is not defined in the router (there is no defined handler in the app router to handle that Msg types).
Line range hint
221-221: Ensure sentences start with an uppercase letter.- simd query authz --help + Simd query authz --helpx/auth/README.md (9)
Line range hint
40-40: Add a comma for clarity.- actions on behalf of other accounts and enables a granter to grant authorizations + actions on behalf of other accounts, and enables a granter to grant authorizationsThis change improves the readability of the sentence by clearly separating the clauses.
Line range hint
59-59: Correct the spelling of "gossiping".- gossipping transactions + gossiping transactionsThe correct spelling is "gossiping". This correction ensures professionalism and accuracy in documentation.
Line range hint
64-64: Correct the spelling of "CometBFT".- CometBFT + TendermintThe term "CometBFT" appears to be a typo or outdated term for the consensus engine used in the Cosmos SDK, which is known as Tendermint. Updating this will avoid confusion.
Line range hint
80-80: Add a space after the period for consistency.- `sdk.Coins`. Accounts are exposed externally as an + `sdk.Coins`. Accounts are exposed externally as anAdding a space after the period aligns with standard writing practices and improves the readability of the document.
Line range hint
148-148: Simplify the language for clarity.- CometBFT proposers presently have the ability to include in their proposed block transactions which fail `CheckTx`. + Tendermint proposers can include transactions that fail `CheckTx` in their proposed blocks.This revision simplifies the sentence structure and updates the terminology to "Tendermint", enhancing clarity and accuracy.
Line range hint
186-186: Remove unnecessary hyphenation.- fully-permissioned account keeper + fully permissioned account keeperThe adverb "fully" already modifies the adjective "permissioned" clearly, so the hyphen is not necessary.
Line range hint
252-252: Correct the possessive form of "it's" to "its".- query for an account by it's address + query for an account by its address"It's" is a contraction for "it is" or "it has", not a possessive form. This correction ensures grammatical accuracy in the documentation.
Line range hint
442-442: Correct the verb form for agreement with the subject.- transactions that was generated offline + transactions that were generated offlineThe verb "were" correctly matches the plural subject "transactions", ensuring grammatical correctness.
Line range hint
491-491: Correct the possessive form of "it's" to "its".- query for an account by it's address + query for an account by its address"It's" is a contraction for "it is" or "it has", not a possessive form. This correction ensures grammatical accuracy in the documentation.
| @@ -40,7 +40,7 @@ on behalf of one account to other accounts. The design is defined in the [ADR 03 | |||
| A *grant* is an allowance to execute a Msg by the grantee on behalf of the granter. | |||
| Authorization is an interface that must be implemented by a concrete authorization logic to validate and execute grants. Authorizations are extensible and can be defined for any Msg service method even outside of the module where the Msg method is defined. See the `SendAuthorization` example in the next section for more details. | |||
There was a problem hiding this comment.
Consider simplifying the phrase to avoid redundancy.
- even outside of the module where the Msg method is defined
+ outside the module where the Msg method is definedCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Authorization is an interface that must be implemented by a concrete authorization logic to validate and execute grants. Authorizations are extensible and can be defined for any Msg service method even outside of the module where the Msg method is defined. See the `SendAuthorization` example in the next section for more details. | |
| Authorization is an interface that must be implemented by a concrete authorization logic to validate and execute grants. Authorizations are extensible and can be defined for any Msg service method outside the module where the Msg method is defined. See the `SendAuthorization` example in the next section for more details. |
| @@ -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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 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). |
| @@ -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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * `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 about how to write module specs in the [spec guidelines](../../spec/SPEC_MODULE.md). |
| @@ -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.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 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. |
| @@ -7,13 +7,13 @@ 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). | |||
| Learn more about the rationale of App Wiring in [ADR-057](../../architecture/adr-057-app-wiring.md). | |||
There was a problem hiding this comment.
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
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 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). |
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (6)
docs/spec/store/interblock-cache.md (4)
Line range hint
31-31: Correct verb agreement in the sentence.- This is data that do not change often + This is data that does not change often
Line range hint
4-21: Correct the list indentation to improve markdown formatting.- * [Inter-block Cache](#inter-block-cache) - * [Synopsis](#synopsis) - * [Overview and basic concepts](#overview-and-basic-concepts) - * [Motivation](#motivation) - * [Definitions](#definitions) - * [System model and properties](#system-model-and-properties) - * [Assumptions](#assumptions) - * [Properties](#properties) - * [Thread safety](#thread-safety) - * [Crash recovery](#crash-recovery) - * [Iteration](#iteration) - * [Technical specification](#technical-specification) - * [General design](#general-design) - * [API](#api) - * [CommitKVCacheManager](#commitkvcachemanager) - * [CommitKVStoreCache](#commitkvstorecache) - * [Implementation details](#implementation-details) - * [History](#history) - * [Copyright](#copyright) + * [Inter-block Cache](#inter-block-cache) + * [Synopsis](#synopsis) + * [Overview and basic concepts](#overview-and-basic-concepts) + * [Motivation](#motivation) + * [Definitions](#definitions) + * [System model and properties](#system-model-and-properties) + * [Assumptions](#assumptions) + * [Properties](#properties) + * [Thread safety](#thread-safety) + * [Crash recovery](#crash-recovery) + * [Iteration](#iteration) + * [Technical specification](#technical-specification) + * [General design](#general-design) + * [API](#api) + * [CommitKVCacheManager](#commitkvcachemanager) + * [CommitKVStoreCache](#commitkvstorecache) + * [Implementation details](#implementation-details) + * [History](#history) + * [Copyright](#copyright)
Line range hint
73-265: Remove trailing spaces to adhere to markdown best practices.- The inter-block cache transparently delegates `Commit()` to its aggregate `CommitKVStore`. If the + The inter-block cache transparently delegates `Commit()` to its aggregate `CommitKVStore`. If the - `CacheWrap` wraps a `CommitKVStoreCache` with another caching layer (`CacheKV`). + `CacheWrap` wraps a `CommitKVStoreCache` with another caching layer (`CacheKV`). - It is unclear whether there is a use case for `CacheWrap`. + It is unclear whether there is a use case for `CacheWrap`.
Line range hint
35-35: Start sentences with an uppercase letter.- `Store key` uniquely identifies a store. + `Store key` Uniquely identifies a store.x/authz/README.md (2)
Line range hint
9-9: Start the sentence with an uppercase letter for proper noun consistency.- `x/authz` is an implementation of a Cosmos SDK module... + `X/authz` is an implementation of a Cosmos SDK module...
Line range hint
15-31: Correct the list indentation to improve readability and maintain consistency.- * [Concepts](#concepts) - * [Authorization and Grant](#authorization-and-grant) - * [Built-in Authorizations](#built-in-authorizations) - * [Gas](#gas) - * [State](#state) - * [Grant](#grant) - * [GrantQueue](#grantqueue) - * [Messages](#messages) - * [MsgGrant](#msggrant) - * [MsgRevoke](#msgrevoke) - * [MsgRevokeAll](#msgrevokeall) - * [MsgExec](#msgexec) - * [MsgPruneExpiredGrants](#msgpruneexpiredgrants) - * [Events](#events) - * [Client](#client) - * [CLI](#cli) - * [gRPC](#grpc) - * [REST](#rest) + * [Concepts](#concepts) + * [Authorization and Grant](#authorization-and-grant) + * [Built-in Authorizations](#built-in-authorizations) + * [Gas](#gas) + * [State](#state) + * [Grant](#grant) + * [GrantQueue](#grantqueue) + * [Messages](#messages) + * [MsgGrant](#msggrant) + * [MsgRevoke](#msgrevoke) + * [MsgRevokeAll](#msgrevokeall) + * [MsgExec](#msgexec) + * [MsgPruneExpiredGrants](#msgpruneexpiredgrants) + * [Events](#events) + * [Client](#client) + * [CLI](#cli) + * [gRPC](#grpc) + * [REST](#rest)
| @@ -59,7 +59,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ | |||
|
|
|||
| * [#19672](https://github.com/cosmos/cosmos-sdk/pull/19672) `PreBlock` now returns only an error for consistency with server/v2. The SDK has upgraded x/upgrade accordingly. | |||
| * [#18857](https://github.com/cosmos/cosmos-sdk/pull/18857) Moved `FormatCoins` to `x/tx`. | |||
| * [#18861](httpes://github.com/cosmos/cosmos-sdk/pull/18861) Moved `coin.ParseCoin` to `client/v2/internal`. | |||
| * [#18861](https://github.com/cosmos/cosmos-sdk/pull/18861) Moved `coin.ParseCoin` to `client/v2/internal`. | |||
There was a problem hiding this comment.
Update the location of coin.ParseCoin to reflect the PR description accurately.
- Moved `coin.ParseCoin` to `client/v2/internal`.
+ Moved `coin.ParseCoin` to a new location (not specified).Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * [#18861](https://github.com/cosmos/cosmos-sdk/pull/18861) Moved `coin.ParseCoin` to `client/v2/internal`. | |
| * [#18861](https://github.com/cosmos/cosmos-sdk/pull/18861) Moved `coin.ParseCoin` to a new location (not specified). |
| @@ -32,7 +32,7 @@ This module is used in the Cosmos Hub. | |||
|
|
|||
| ## Concepts | |||
|
|
|||
| **Note:** The auth module is different from the [authz module](../modules/authz/). | |||
| **Note:** The auth module is different from the [authz module](../authz/). | |||
There was a problem hiding this comment.
Consider enhancing the description of the auth and authz modules with specific examples or use cases to provide clearer insights into their functionalities and distinctions.
Would you like me to draft a more detailed description for these modules?
|
@MasterPi-2124 could you merge main into your branch |
|
Sure, just merged |
This reverts commit e901584.
Description
This PR fixes all broken URLs in the repo using
lycheetool. However, the tool only checks and reports the broken links, so we had to fix them manually. If the tool is helpful, I can set up a CI job to periodically check and create new issues reporting all broken links, decreasing the number of spam PRs.CHANGELOG.mdfiles are excluded from the search. We can also exclude files with custom regex names so the tool won't look for the files matching these regex.Note: There are still some URLs and file paths that could not be fixed as the new paths are missing. Below is the list of broken links:
https://github.com/cosmos/security/blob/main/DISCLOSURE.md
https://github.com/cosmos/security/blob/main/EXAMPLES.md
Failed: Not found
Failed: Not found
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Summary by CodeRabbit
coin.ParseCoinfunction within the Cosmos SDK, enhancing structural consistency.