chore(docs/learn): fix broken links #20193

goofylfg · 2024-04-26T06:46:49Z

Description

similar to: #20169
checkd globally

link like https://docs.cosmos.network/main/build/architecture/adr-059-test-scopes.html is fline, no need replace from build/architecture to architecture

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...

included the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers 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...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Documentation
- Corrected broken links in the advanced learning section for:
  - Typed Events in the Cosmos SDK documentation.
  - Custom panic handling in the middleware documentation.

coderabbitai · 2024-04-26T06:46:57Z

Walkthrough

This update primarily involves fixing broken links in the Cosmos SDK documentation. The corrections ensure that the links now accurately point to their intended destinations within the modified directory structure.

Changes

File Path	Change Summary
`docs/learn/advanced/08-events.md`	Corrected link to `adr-032-typed-events.md`
`docs/learn/advanced/11-runtx_middleware.md`	Corrected link to `adr-022-custom-panic-handling.md`

Possibly related issues

Issue [Documentation]: docs path updates cause some broken link #20127: The changes in this PR address broken links, similar to the issue reported here. This suggests a systemic problem with link management in documentation updates.
Issue [Documentation]: Fix broken links pointing to restructured CometBFT v1 documentation #19904: Although this issue deals with broken links in CometBFT documentation and not directly related to the SDK, the underlying problem of managing documentation links is common.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fbb94f4 and 1c2aed8.

Files selected for processing (2)

docs/learn/advanced/08-events.md (1 hunks)
docs/learn/advanced/11-runtx_middleware.md (1 hunks)

Additional Context Used

LanguageTool (78)

docs/learn/advanced/08-events.md (62)

Near line 6: An accent character was used instead of an apostrophe.
Context: ...ition: 1 --- # Events :::note Synopsis Events are objects that contain information ab...

Near line 13: Possible spelling mistake found.
Context: ...tion](../beginner/00-app-anatomy.md) * [CometBFT Documentation on Events](https://docs.c...

Near line 19: Possible spelling mistake found.
Context: ...ed in the Cosmos SDK as an alias of the ABCI Event type and take the form of: `{ev...

Near line 28: An accent character was used instead of an apostrophe.
Context: ...he "message" type to filter Events by Msgs. * A list of attributes are key-value...

Near line 29: Consider using a more formal verb to strengthen your wording.
Context: ...f attributes are key-value pairs that give more information about the categorized ...

Near line 36: Possible spelling mistake found.
Context: ...ttribute value. ::: Typed Events are Protobuf-defined [messages](../../architecture/adr-032-t...

Near line 37: Add a space between sentences.
Context: ... a per-module basis and are read as proto.Message. Legacy Events are defined on a **pe...

Near line 39: Possible spelling mistake found.
Context: ...e. They are triggered from the module's Protobuf [Msg service](../../build/building-mo...

Near line 40: Possible spelling mistake found.
Context: ...odules/03-msg-services.md) by using the EventManager. In addition, each mo...

Near line 44: Possible spelling mistake found.
Context: ...engine in the response of the following ABCI messages: * [BeginBlock](./00-baseap...

Near line 55: Possible typo: you repeated a whitespace
Context: ...ry Events using the Cosmos SDK. | Event | Description ...

Near line 55: Possible typo: you repeated a whitespace
Context: ... | Description | | ------------------------------------...

Near line 57: Possible spelling mistake found.
Context: ...----------------------------------- | | tx.height=23 ...

Near line 57: Possible typo: you repeated a whitespace
Context: ...--------------------- | | tx.height=23 | Query all transactions at height 23 ...

Near line 57: Possible typo: you repeated a whitespace
Context: ... | Query all transactions at height 23 | | `message.action='/cosmos.bank.v1beta...

Near line 58: Unpaired symbol: ‘'’ seems to be missing
Context: ... | | message.action='/cosmos.bank.v1beta1.Msg/Send' | Query all transactions containing a ...

Near line 58: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d'| Query all transactions containing a x/bankSend[ServiceMsg`](../../bui...

Near line 58: Possible typo: you repeated a whitespace
Context: ...es.md). Note the 's around the value. | | message.module='bank' ...

Near line 59: Possible typo: you repeated a whitespace
Context: ... | | message.module='bank' | Query all transactions containing mess...

Near line 59: Possible typo: you repeated a whitespace
Context: ...module. Note the 's around the value. | | `create_validator.validator='cosmosv...

Near line 60: Possible typo: you repeated a whitespace
Context: ...ate_validator.validator='cosmosval1...'` | x/staking-specific Event, see [x/staki...

Near line 60: Possible typo: you repeated a whitespace
Context: ...../../build/modules/staking/README.md). | ##...

Near line 62: Possible spelling mistake found.
Context: ... ## EventManager In Cosmos SDK applications, Events are...

Near line 64: Possible spelling mistake found.
Context: ...re managed by an abstraction called the EventManager. Internally, the EventManager tracks...

Near line 65: Possible spelling mistake found.
Context: ...led the EventManager. Internally, the EventManager tracks a list of Events for the entire...

Near line 65: Possible spelling mistake found.
Context: ...Events for the entire execution flow of FinalizeBlock (i.e. transaction execution, `BeginBl...

Near line 66: Possible spelling mistake found.
Context: ...izeBlock (i.e. transaction execution,BeginBlock, EndBlock`). ```go reference https:/...

Near line 66: Possible spelling mistake found.
Context: ...e. transaction execution, BeginBlock, EndBlock). ```go reference https://github.com/...

Near line 72: Possible spelling mistake found.
Context: ...lpha.0/types/events.go#L19-L26 ``` The EventManager comes with a set of useful methods to ...

Near line 73: Possible spelling mistake found.
Context: ...by module and application developers is EmitTypedEvent or EmitEvent that tracks an Event in...

Near line 73: Possible spelling mistake found.
Context: ...ation developers is EmitTypedEvent or EmitEvent that tracks an Event in the `EventMana...

Near line 74: Possible spelling mistake found.
Context: ...EmitEvent that tracks an Event in the EventManager. ```go reference https://github.com/c...

Near line 80: Possible spelling mistake found.
Context: ...rs should handle Event emission via the EventManager#EmitTypedEvent or `EventManager#EmitEv...

Near line 80: Possible spelling mistake found.
Context: ...ia the EventManager#EmitTypedEvent or EventManager#EmitEvent in each message Handler an...

Near line 81: Possible spelling mistake found.
Context: ...in each messageHandlerand in eachBeginBlock/EndBlockhandler. TheEventManager`...

Near line 81: Possible spelling mistake found.
Context: ...sage Handler and in each BeginBlock/EndBlock handler. The EventManager is accesse...

Near line 81: Possible spelling mistake found.
Context: ...ch BeginBlock/EndBlock handler. The EventManager is accessed via the [Context](./02-c...

Near line 99: Possible spelling mistake found.
Context: ...Key, attributeValue)), ) ``` Where the EventManager is accessed via the [`Context`](./02-c...

Near line 102: Possible spelling mistake found.
Context: ... typically implement Events and use the EventManager in modules. ## Subscribing to Events ...

Near line 106: Possible spelling mistake found.
Context: ... ## Subscribing to Events You can use CometBFT's [Websocket](https://docs.cometbft.com...

Near line 106: Possible spelling mistake found.
Context: ...bing to Events You can use CometBFT's [Websocket](https://docs.cometbft.com/v1.0/explana...

Near line 119: Possible spelling mistake found.
Context: ...e='attributeValue'" } } ``` The main eventCategory you can subscribe to are: * `NewBlock...

Near line 121: Loose punctuation mark.
Context: ... you can subscribe to are: * NewBlock: Contains Events triggered during `Begin...

Near line 121: Possible spelling mistake found.
Context: ...lock: Contains Events triggered during BeginBlockandEndBlock. * Tx`: Contains Event...

Near line 121: Possible spelling mistake found.
Context: ...vents triggered during BeginBlock and EndBlock. * Tx: Contains Events triggered dur...

Near line 122: Loose punctuation mark.
Context: ...ring BeginBlock and EndBlock. * Tx: Contains Events triggered during `Deliv...

Near line 122: Possible spelling mistake found.
Context: ... Tx: Contains Events triggered during DeliverTx (i.e. transaction processing). * `Vali...

Near line 123: Loose punctuation mark.
Context: ...ion processing). * ValidatorSetUpdates: Contains validator set updates for the ...

Near line 126: Possible spelling mistake found.
Context: ...e full list of Event categories [on the CometBFT Go documentation](https://pkg.go.dev/gi...

Near line 128: Possible spelling mistake found.
Context: ...transaction triggers an Event of typeEventMintand has anIdand anOwnerasatt...

Near line 128: Possible spelling mistake found.
Context: ...an Event of type EventMint and has an Id and an Owner as attributes (as def...

Near line 142: This sentence does not start with an uppercase letter.
Context: ...D mint.owner='ownerAddress'" } } ``` where ownerAddress is an address following ...

Near line 143: Possible spelling mistake found.
Context: ....owner='ownerAddress'" } } ``` where ownerAddress is an address following the [`AccAddre...

Near line 143: Possible spelling mistake found.
Context: ...nerAddress is an address following the [AccAddress`](../beginner/03-accounts.md#addresses)...

Near line 149: Possible spelling mistake found.
Context: ...emitted for all messages, directly from baseapp. * message.action: The name of the ...

Near line 151: Loose punctuation mark.
Context: ...ctly from baseapp. * message.action: The name of the message type. * `messag...

Near line 152: Loose punctuation mark.
Context: ... of the message type. * message.sender: The address of the message signer. * `m...

Near line 153: Loose punctuation mark.
Context: ...f the message signer. * message.module: The name of the module that emitted the...

Near line 156: Possible spelling mistake found.
Context: .... :::tip The module name is assumed by baseapp to be the second element of the messag...

Near line 156: Do you wish to insert an arrow?
Context: ...he second element of the message route: "cosmos.bank.v1beta1.MsgSend" -> "bank". In case a module does not foll...

Near line 157: Possible spelling mistake found.
Context: ...to keep emitting the module name event. Baseapp only emits that event if the module ha...

Near line 158: “Module” is a singular noun. It appears that the verb form is incorrect.
Context: ...pp` only emits that event if the module have not already done so. :::

docs/learn/advanced/11-runtx_middleware.md (16)

Near line 5: Possible spelling mistake found.
Context: --- sidebar_position: 1 --- # RunTx recovery middleware BaseApp.runTx() ...

Near line 7: This sentence does not start with an uppercase letter.
Context: ... recovery middleware BaseApp.runTx() function handles Go panics that might occur duri...

Near line 19: This sentence does not start with an uppercase letter.
Context: .../recovery.go#L14-L17 ``` recoveryObj is a return value for `recover()` function...

Near line 19: Possible spelling mistake found.
Context: ...value for recover() function from the buildin Go package. Contract: * Recovery...

Near line 23: Possible spelling mistake found.
Context: ...buildin Go package. Contract: * RecoveryHandler returns nil if recoveryObj wasn't h...

Near line 23: Possible spelling mistake found.
Context: ...:** * RecoveryHandler returns nil if recoveryObj wasn't handled and should be passed to...

Near line 24: Possible spelling mistake found.
Context: ...ssed to the next recovery middleware; * RecoveryHandler returns a non-nil error if `recoveryO...

Near line 24: Possible spelling mistake found.
Context: ...eryHandler returns a non-nil error if recoveryObj was handled; ## Custom RecoveryHandle...

Near line 26: Possible spelling mistake found.
Context: ...f recoveryObj was handled; ## Custom RecoveryHandler register `BaseApp.AddRunTxRecoveryHand...

Near line 29: Possible spelling mistake found.
Context: ...yHandler(handlers ...RecoveryHandler)` BaseApp method adds recovery middleware to the ...

Near line 33: Did you mean “Let's” (let’s = let us; lets = 3rd person singular of ‘let’)?
Context: ...he default recovery chain. ## Example Lets assume we want to emit the "Consensus f...

Near line 34: Please check whether ‘omit’ (exclude) might be the correct word here instead of ‘emit’ (give out).
Context: ...in. ## Example Lets assume we want to emit the "Consensus failure" chain state if ...

Near line 47: Did you mean: “By default,”?
Context: ...s nil") panic(err) } } ``` By default that panic would be recovered and an er...

Near line 48: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...By default that panic would be recovered and an error message will be printed to log...

Near line 48: It seems that a comma is missing.
Context: ...ill be printed to log. To override that behaviour we should register a custom RecoveryHan...

Near line 48: Possible spelling mistake found.
Context: ...t behaviour we should register a custom RecoveryHandler: ```go // Cosmos SDK application const...

Path-based Instructions (2)

docs/learn/advanced/11-runtx_middleware.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/learn/advanced/08-events.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (2)

docs/learn/advanced/11-runtx_middleware.md (1)

11-11: Corrected link to ADR-022.

docs/learn/advanced/08-events.md (1)

36-36: Corrected link to ADR-032.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

goofylfg added 2 commits April 26, 2024 14:41

Update 11-runtx_middleware.md

fa94c9f

Update 08-events.md

1c2aed8

goofylfg requested a review from a team as a code owner April 26, 2024 06:46

facundomedica approved these changes Apr 26, 2024

View reviewed changes

tac0turtle approved these changes Apr 26, 2024

View reviewed changes

tac0turtle added this pull request to the merge queue Apr 26, 2024

Merged via the queue into cosmos:main with commit e856c74 Apr 26, 2024
58 checks passed

meetrick pushed a commit to meetrick/cosmos-sdk that referenced this pull request Apr 29, 2024

chore(docs/learn): fix broken links (cosmos#20193)

688163c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(docs/learn): fix broken links #20193

chore(docs/learn): fix broken links #20193

goofylfg commented Apr 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 26, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

chore(docs/learn): fix broken links #20193

chore(docs/learn): fix broken links #20193

Conversation

goofylfg commented Apr 26, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 26, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

goofylfg commented Apr 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 26, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)