fix(docs): fix broken links #20169
fix(docs): fix broken links #20169
Conversation
WalkthroughWalkthroughThe updates focus on correcting and updating links within the Cosmos SDK documentation. This involves adjusting paths to architecture documents, Protobuf encoding references, and ADR links across various sections of the documentation. Changes
Possibly related issues
Recent Review DetailsConfiguration used: .coderabbit.yml Files selected for processing (3)
Additional Context UsedLanguageTool (446)
Path-based Instructions (3)
Additional comments not posted (3)
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (6)
docs/learn/beginner/03-accounts.md (3)
Line range hint
20-22: Consider adding a comma after "For HD key derivation" for better readability.- For HD key derivation the Cosmos SDK uses a standard called [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki). + For HD key derivation, the Cosmos SDK uses a standard called [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki).
Line range hint
74-75: Remove the extra comma before "as implemented in the Cosmos SDK'scrypto/keys/secp256r1package".- * `secp256r1`, as implemented in the [Cosmos SDK's `crypto/keys/secp256r1` package](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/crypto/keys/secp256r1/pubkey.go), + * `secp256r1` as implemented in the [Cosmos SDK's `crypto/keys/secp256r1` package](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/crypto/keys/secp256r1/pubkey.go)
Line range hint
86-86: Start the sentence with an uppercase letter for consistency.- `Addresses` and `PubKey`s are both public information that identifies actors in the application. + `Addresses` and `PubKey`s are both public information that identify actors in the application.docs/learn/beginner/00-app-anatomy.md (3)
Line range hint
55-55: Use the correct form of possessive plural.- **A list of module's `keeper`s.** + **A list of modules' `keeper`s.**
Line range hint
84-87: Correct the indentation of unordered list items.- * [`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. + * [`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 consistent list markers in Markdown.- - 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.
| @@ -51,7 +51,7 @@ The most used implementation of the `Tx` interface is the Protobuf `Tx` message, | |||
| https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/proto/cosmos/tx/v1beta1/tx.proto#L13-L26 | |||
| ``` | |||
|
|
|||
| Because Protobuf serialization is not deterministic, the Cosmos SDK uses an additional `TxRaw` type to denote the pinned bytes over which a transaction is signed. Any user can generate a valid `body` and `auth_info` for a transaction, and serialize these two messages using Protobuf. `TxRaw` then pins the user's exact binary representation of `body` and `auth_info`, called respectively `body_bytes` and `auth_info_bytes`. The document that is signed by all signers of the transaction is `SignDoc` (deterministically serialized using [ADR-027](../../build/architecture/adr-027-deterministic-protobuf-serialization.md)): | |||
| Because Protobuf serialization is not deterministic, the Cosmos SDK uses an additional `TxRaw` type to denote the pinned bytes over which a transaction is signed. Any user can generate a valid `body` and `auth_info` for a transaction, and serialize these two messages using Protobuf. `TxRaw` then pins the user's exact binary representation of `body` and `auth_info`, called respectively `body_bytes` and `auth_info_bytes`. The document that is signed by all signers of the transaction is `SignDoc` (deterministically serialized using [ADR-027](../../architecture/adr-027-deterministic-protobuf-serialization.md)): | |||
There was a problem hiding this comment.
Update the link to ADR-027 to reflect the new directory structure.
| @@ -100,7 +100,7 @@ | |||
|
|
|||
| Data is formatted using a set of `ValueRenderer` which the SDK provides defaults for all the known messages and value types. Chain developers can also opt to implement their own `ValueRenderer` for a type/message if they'd like to display information differently. | |||
|
|
|||
| If you wish to learn more, please refer to [ADR-050](../../build/architecture/adr-050-sign-mode-textual.md). | |||
| If you wish to learn more, please refer to [ADR-050](../../architecture/adr-050-sign-mode-textual.md). | |||
There was a problem hiding this comment.
Ensure the link to ADR-050 is updated to reflect the new directory structure.
Description
relative path changed:
build/architecture->architectureso markdown reference path borken.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
Keyringmethods.