docs: fix broken links #20766
docs: fix broken links #20766
Conversation
This reverts commit e901584.
WalkthroughThis update involves correcting relative paths to links within several Markdown documentation files across different sections of the project. The main aim is to ensure that all internal links in the documentation point to the correct locations without resulting in broken links. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (4)
docs/build/building-apps/01-app-go-v2.md (1)
Line range hint
60-60: Grammar correction needed for embedding configuration.The word "embed" should be changed to "embedded" to correct the grammatical error.
- The configuration can then be embed with `go:embed` + The configuration can then be embedded with `go:embed`x/auth/README.md (3)
Line range hint
148-148: Simplify language for clarity.The phrase "have the ability to" can be simplified to "can" for brevity and clarity.
- Note that the `AnteHandler` is called on both `CheckTx` and `DeliverTx`, as CometBFT proposers presently have the ability to include in their proposed block transactions which fail `CheckTx`. + Note that the `AnteHandler` is called on both `CheckTx` and `DeliverTx`, as CometBFT proposers can include in their proposed block transactions which fail `CheckTx`.
Line range hint
252-252: Grammar correction: possessive pronoun.Replace "it's" with "its" to correct the possessive form.
- The `account` endpoint allow users to query for an account by it's address. + The `account` endpoint allow users to query for an account by its address.
Line range hint
507-507: Grammar correction: possessive pronoun.Replace "it's" with "its" to correct the possessive form in the REST endpoint description.
- The `account` endpoint allow users to query for an account by it's address. + The `account` endpoint allow users to query for an account by its address.
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (6)
- docs/build/building-apps/01-app-go-v2.md (1 hunks)
- docs/build/building-modules/03-msg-services.md (1 hunks)
- docs/build/building-modules/11-structure.md (1 hunks)
- docs/build/building-modules/13-upgrade.md (1 hunks)
- x/auth/README.md (1 hunks)
- x/authz/README.md (1 hunks)
Additional context used
Path-based instructions (6)
docs/build/building-modules/13-upgrade.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/build/building-modules/11-structure.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/build/building-apps/01-app-go-v2.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/build/building-modules/03-msg-services.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"x/authz/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"x/auth/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Markdownlint
docs/build/building-modules/13-upgrade.md
61-61: Column: 1 (MD010, no-hard-tabs)
Hard tabsdocs/build/building-modules/11-structure.md
82-82: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
84-84: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
88-88: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
89-89: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
90-90: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
91-91: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
92-92: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
93-93: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
94-94: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
95-95: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
96-96: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentationdocs/build/building-apps/01-app-go-v2.md
100-100: Expected: 0 or 2; Actual: 4 (MD009, no-trailing-spaces)
Trailing spaces
135-135: Column: 1 (MD010, no-hard-tabs)
Hard tabsdocs/build/building-modules/03-msg-services.md
38-38: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
40-40: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
44-44: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
57-57: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
80-80: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
93-93: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
63-63: Column: 1 (MD010, no-hard-tabs)
Hard tabs
64-64: Column: 1 (MD010, no-hard-tabs)
Hard tabs
65-65: Column: 1 (MD010, no-hard-tabs)
Hard tabs
66-66: Column: 1 (MD010, no-hard-tabs)
Hard tabs
67-67: Column: 1 (MD010, no-hard-tabs)
Hard tabs
90-90: Column: 1 (MD010, no-hard-tabs)
Hard tabs
97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs
98-98: Column: 1 (MD010, no-hard-tabs)
Hard tabs
99-99: Column: 1 (MD010, no-hard-tabs)
Hard tabs
100-100: Column: 1 (MD010, no-hard-tabs)
Hard tabs
101-101: Column: 1 (MD010, no-hard-tabs)
Hard tabsx/authz/README.md
15-15: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
16-16: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
17-17: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
19-19: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
20-20: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
22-22: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
23-23: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
24-24: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
25-25: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
26-26: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
29-29: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
30-30: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
31-31: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentationx/auth/README.md
21-21: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
23-23: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
26-26: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
29-29: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
30-30: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
31-31: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
432-432: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
71-71: Column: 20 (MD010, no-hard-tabs)
Hard tabs
103-103: Column: 1 (MD010, no-hard-tabs)
Hard tabs
105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs
106-106: Column: 1 (MD010, no-hard-tabs)
Hard tabs
108-108: Column: 1 (MD010, no-hard-tabs)
Hard tabs
109-109: Column: 1 (MD010, no-hard-tabs)
Hard tabs
111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs
112-112: Column: 1 (MD010, no-hard-tabs)
Hard tabs
114-114: Column: 1 (MD010, no-hard-tabs)
Hard tabs
115-115: Column: 1 (MD010, no-hard-tabs)
Hard tabs
117-117: Column: 1 (MD010, no-hard-tabs)
Hard tabs
118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs
192-192: Column: 1 (MD010, no-hard-tabs)
Hard tabs
193-193: Column: 1 (MD010, no-hard-tabs)
Hard tabs
195-195: Column: 1 (MD010, no-hard-tabs)
Hard tabs
196-196: Column: 1 (MD010, no-hard-tabs)
Hard tabs
198-198: Column: 1 (MD010, no-hard-tabs)
Hard tabs
199-199: Column: 1 (MD010, no-hard-tabs)
Hard tabs
201-201: Column: 1 (MD010, no-hard-tabs)
Hard tabs
202-202: Column: 1 (MD010, no-hard-tabs)
Hard tabs
204-204: Column: 1 (MD010, no-hard-tabs)
Hard tabs
205-205: Column: 1 (MD010, no-hard-tabs)
Hard tabs
207-207: Column: 1 (MD010, no-hard-tabs)
Hard tabs
208-208: Column: 1 (MD010, no-hard-tabs)
Hard tabs
210-210: Column: 1 (MD010, no-hard-tabs)
Hard tabs
211-211: Column: 1 (MD010, no-hard-tabs)
Hard tabs
213-213: Column: 1 (MD010, no-hard-tabs)
Hard tabs
214-214: Column: 1 (MD010, no-hard-tabs)
Hard tabs
216-216: Column: 1 (MD010, no-hard-tabs)
Hard tabs
217-217: Column: 1 (MD010, no-hard-tabs)
Hard tabs
219-219: Column: 1 (MD010, no-hard-tabs)
Hard tabs
220-220: Column: 1 (MD010, no-hard-tabs)
Hard tabs
500-500: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
LanguageTool
docs/build/building-modules/11-structure.md
[uncategorized] ~28-~28: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...── tx.proto ``` *{module_name}.proto: The module's common message type defini...
[uncategorized] ~29-~29: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...sage type definitions. *genesis.proto: The module's message type definitions r...
[uncategorized] ~30-~30: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...elated to genesis state. *query.proto: The module's Query service and related ...
[uncategorized] ~31-~31: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...d message type definitions. *tx.proto: The module's Msg service and related me...
[uncategorized] ~79-~79: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... tx.pb.go └── README.md ``` *client/: The module's CLI client functionality i...
[uncategorized] ~80-~80: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...odule's CLI testing suite. *exported/: The module's exported types - typically...
[style] ~80-~80: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...expected_keepers.gofile (see below) in order to avoid a direct dependency on the module...
[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...leviates import cycle chaos. *keeper/: The module'sKeeperandMsgServeri...
[uncategorized] ~82-~82: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...gServerimplementation. *abci.go: The module'sBeginBlockerandEndBlo...
[uncategorized] ~83-~83: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...lockerneed to be defined). *module/: The module'sAppModule` implementation...
[uncategorized] ~84-~84: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...duleimplementation. *autocli.go`: The module [autocli](https://docs.cosmo...
[uncategorized] ~85-~85: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...n/core/autocli) options. *simulation/: The module's [simulation](./14-simulato...
[uncategorized] ~86-~86: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or application (simapp). *README.md: The module's specification documents ou...
[uncategorized] ~88-~88: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ed by Protocol Buffers. *codec.go: The module's registry methods for inter...
[uncategorized] ~89-~89: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s for interface types. *errors.go: The module's sentinel errors. * `ev...
[uncategorized] ~90-~90: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ule's sentinel errors. *events.go: The module's event types and constructo...
[uncategorized] ~91-~91: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...onstructors. *expected_keepers.go: The module's [expected keeper](./06-kee...
[uncategorized] ~92-~92: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...finition) interfaces. *genesis.go: The module's genesis state methods and ...
[uncategorized] ~93-~93: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ds and helper functions. *keys.go: The module's store keys and associated ...
[uncategorized] ~94-~94: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ciated helper functions. *msgs.go: The module's message type definitions a...
[uncategorized] ~95-~95: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...nd associated methods. *params.go: The module's parameter type definitions...
[uncategorized] ~96-~96: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... and associated methods. **.pb.go: The module's type definitions generated...docs/build/building-apps/01-app-go-v2.md
[grammar] ~60-~60: Consider using either the past participle “embedded” or the present participle “embedding” here. (BEEN_PART_AGREEMENT)
Context: ...r JSON. The configuration can then be embed withgo:embedand read with [`appconf...
[uncategorized] ~142-~142: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...nually constructed instead of injected. Otherwise it will miss the non depinject modules ...docs/build/building-modules/03-msg-services.md
[uncategorized] ~24-~24: The grammatical number of this noun doesn’t look right. Consider replacing it. (AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
Context: ...terface forx/bank, which exposes twotransaction.Msgs: ```go reference https://github....
[uncategorized] ~30-~30: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ...When possible, the existing module's [Keeper`](./06-keeper.md) should implemen...
[uncategorized] ~78-~78: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ...essful, themsgServermethod uses thekeeperfunctions to ac...
[uncategorized] ~105-~105: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...anced/08-events.md) to learn more about events. The invokedmsgServermethod return...x/authz/README.md
[style] ~41-~41: This phrase is redundant. Consider using “outside”. (OUTSIDE_OF)
Context: ...defined for any Msg service method even outside of the module where the Msg method is defi...
[uncategorized] ~71-~71: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...SpendLimitthat specifies the maximum amount of tokens the grantee can spend. The `S...
[uncategorized] ~72-~72: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...s to which addresses a grantee can send token. ```protobuf reference https://github....
[uncategorized] ~87-~87: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...ens` that keeps track of a limit to the amount of tokens that can be delegated/undeleg...
[style] ~98-~98: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ng/types/authz.go#L15-L35 ``` ### Gas In order to prevent DoS attacks, granting `StakeAut...
[uncategorized] ~99-~99: Do not mix variants of the same word (‘authorize’ and ‘authorise’) within a single text. (EN_WORD_COHERENCY)
Context: ...gas.StakeAuthorizationallows you to authorize another account to delegate, undelegate...
[grammar] ~99-~99: After the number ‘10’, use a plural noun. Did you mean “gases”, “gasses”? (CD_NNU)
Context: ...iterates over these lists and charge 10 gas for each validator in both of the lists...
[uncategorized] ~101-~101: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...e of particularmsgType) from the list and we are charging 20 gas per iteration. ...
[grammar] ~101-~101: After the number ‘20’, use a plural noun. Did you mean “gases”, “gasses”? (CD_NNU)
Context: ...`) from the list and we are charging 20 gas per iteration. ## State ### Grant Gr...
[uncategorized] ~107-~107: A comma may be missing after the conjunctive/linking adverb ‘Hence’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ... and Authorization type (its type URL). Hence we only allow one grant for the (grante...
[typographical] ~139-~139: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ...cated in the key. ## Messages In this section we describe the processing of messages ...
[uncategorized] ~153-~153: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...l be created if noexpirationtime is provided sinceexpirationis optional). * prov...
[uncategorized] ~197-~197: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...permission to run the transaction. * if granted authorization is expired. ### MsgPrune...x/auth/README.md
[style] ~92-~92: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...nt struct conforming to the interface - in order to write the account to the store, the acc...
[style] ~148-~148: The phrase ‘have the ability to’ might be wordy. Consider using “can”. (HAS_THE_ABILITY_TO)
Context: ...verTx`, as CometBFT proposers presently have the ability to include in their proposed block transac...
[uncategorized] ~154-~154: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...lowing order: *SetUpContextDecorator: Sets theGasMeterin theContextan...
[uncategorized] ~156-~156: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ed. *RejectExtensionOptionsDecorator: Rejects all extension options which can...
[uncategorized] ~158-~158: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...f transactions. *MempoolFeeDecorator: Checks if thetxfee is above local m...
[uncategorized] ~160-~160: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...gCheckTx. *ValidateBasicDecorator: Callstx.ValidateBasicand returns an...
[uncategorized] ~162-~162: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...nil error. *TxTimeoutHeightDecorator: Check for atxheight timeout. * `Va...
[uncategorized] ~164-~164: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ight timeout. *ValidateMemoDecorator: Validatestxmemo with application pa...
[uncategorized] ~166-~166: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...il error. *ConsumeGasTxSizeDecorator: Consumes gas proportional to thetxs...
[uncategorized] ~168-~168: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...tion parameters. *DeductFeeDecorator: Deducts theFeeAmountfrom first sign...
[uncategorized] ~170-~170: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...granter account. *SetPubKeyDecorator: Sets the pubkey from atx's signers t...
[uncategorized] ~172-~172: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... context. *ValidateSigCountDecorator: Validates the number of signatures in `...
[uncategorized] ~174-~174: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...-parameters. *SigGasConsumeDecorator: Consumes parameter-defined amount of ga...
[uncategorized] ~176-~176: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ecorator. *SigVerificationDecorator`: Verifies all signatures are valid. This...
[uncategorized] ~178-~178: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...orator. *IncrementSequenceDecorator`: Increments the account sequence for eac...
[style] ~186-~186: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’. (HYPHENATED_LY_ADVERB_ADJECTIVE)
Context: ... ### Account Keeper Presently only one fully-permissioned account keeper is exposed, which has th...
[uncategorized] ~252-~252: Did you mean “its” (the possessive pronoun)? (ITS_PREMIUM)
Context: ... allow users to query for an account by it's address. ```bash simd query auth accou...
[style] ~403-~403: Consider using a more formal alternative. (MORE_INFO)
Context: ... Use directly the--helpflag to get more information about thetxcommand. ```bash simd t...
[grammar] ~436-~436: Please verify that the plural noun “transactions” is in agreement with the quantifier “one”. Did you mean to use the singular form? (ONE_PLURAL)
Context: ... combining the signed transactions into one transactions, use the--appendflag. More informa...
[uncategorized] ~507-~507: Did you mean “its” (the possessive pronoun)? (ITS_PREMIUM)
Context: ... allow users to query for an account by it's address. ```bash cosmos.auth.v1beta1.Q...
[uncategorized] ~690-~690: Did you mean “its” (the possessive pronoun)? (ITS_PREMIUM)
Context: ... allow users to query for an account by it's address. ```bash /cosmos/auth/v1beta1/...
Additional comments not posted (6)
docs/build/building-modules/13-upgrade.md (2)
65-65: Update to ADR-028 link for consistency and correctness.The link to ADR-028 has been updated to point to a specific version (
v0.50.0-alpha.0), which is a good practice to ensure that the link remains valid even if the content changes in the future.
Line range hint
61-61: Consider replacing hard tabs with spaces for consistency in Markdown files.Markdown files typically use spaces instead of tabs for indentation to ensure consistent formatting across different editors and viewers.
[REFACTOR_SUGGESTion]- <hard tab>cfg.RegisterMigration(types.ModuleName, 2, func(ctx sdk.Context) error { + cfg.RegisterMigration(types.ModuleName, 2, func(ctx sdk.Context) error {docs/build/building-modules/11-structure.md (1)
86-86: Updated link to spec guidelines for easier navigation.The link to the spec guidelines has been updated to use a relative path that is one level up, which should correct the issue of a broken link and make navigation easier for the user.
Tools
LanguageTool
[uncategorized] ~86-~86: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or application (simapp). *README.md: The module's specification documents ou...docs/build/building-apps/01-app-go-v2.md (1)
10-10: Updated links to ADR-057 and depinject documentation for clarity.The links to ADR-057 and depinject documentation have been updated to ensure they point to the correct resources, enhancing the document's usefulness and accuracy.
Also applies to: 16-16
docs/build/building-modules/03-msg-services.md (1)
22-22: Updated link to ADR 031 for better resource linking.The link to ADR 031 has been updated to ensure it points directly to the relevant documentation, improving resource accessibility and user navigation.
x/authz/README.md (1)
43-43: Clarification added to differentiate between auth and authz modules.A note has been added to clarify the difference between the
auth(authentication) andauthz(authorization) modules, which is crucial for understanding the distinct functionalities of each module within the Cosmos SDK.
| @@ -32,7 +32,7 @@ This module is used in the Cosmos Hub. | |||
|
|
|||
| ## Concepts | |||
|
|
|||
| **Note:** The auth module is different from the [authz module](../authz/). | |||
| **Note:** The auth module is different from the [authz module](../modules/authz/). | |||
There was a problem hiding this comment.
Clarify the module distinction more concisely.
The explanation about the differences between the auth and authz modules could be more concise to enhance readability.
- **Note:** The auth module is different from the [authz module](../modules/authz/).
-
- The differences are:
-
- * `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.
+ **Note:** The `auth` module handles authentication (base transaction and account types), while the `authz` module manages authorization (granting permissions to execute messages on behalf of another account).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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Note:** The auth module is different from the [authz module](../modules/authz/). | |
| **Note:** The `auth` module handles authentication (base transaction and account types), while the `authz` module manages authorization (granting permissions to execute messages on behalf of another account). |
Description
Most of these links work properly on doc website before #20204 . #20204 edited the links to work in the repo but the links are intended to work on doc website.
e.g.
ADR-057 referenced here in v5.0 works fine.
But ADR-057 referenced here in next version goes 404.
So I reverted the changes while remaining two working fixes.
Summary by CodeRabbit
authmodule's README to the correctauthzmodule path.authzmodule's README to point to the correctauthmodule location.