docs: update diagram to be shown properly

[tianyeyouyou]

Description

the diagram in the transaction lifecycle part is not displaying correctly because of the tab and space usage at the same time. see below screenshot. by only using space( like all the other diagrams in the docs), it can display correctly.

Summary by CodeRabbit

• Documentation
  • Reformatted the transaction lifecycle diagram for improved readability and alignment. No changes to functionality or logic.

[coderabbitai]

Walkthrough

Walkthrough

This update involves reformatting the transaction lifecycle diagram in the documentation, focusing on improving the spacing and alignment of the blocks. The underlying logic and control flow of the transaction lifecycle remain unchanged.

Changes

Files	Change Summary
docs/learn/beginner/01-tx-lifecycle.md	Reformatted the transaction lifecycle diagram, adjusting the spacing and alignment of the blocks.

Possibly related issues

• [Documentation]: Transaction Lifecycle section to be updated #20173: The changes in this PR improve the formatting of the transaction lifecycle diagram, which could help in making the documentation clearer and less disjointed as mentioned in the issue.

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

• Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
• Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
• Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

• Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
• Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
• High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
• Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (22)

docs/learn/beginner/01-tx-lifecycle.md (22)

Line range hint 35-35: Consider simplifying the phrase to enhance readability.

- in order to avoid underestimating
+ to avoid underestimating

---

Line range hint 42-42: Simplify the phrase for clarity.

- whether or not
+ whether

---

Line range hint 60-60: Simplify the phrase to enhance clarity.

- Prior to
+ Before

---

Line range hint 77-78: Consider simplifying these phrases to enhance readability.

- in order to answer queries
+ to answer queries

- In order to verify a `Tx`
+ To verify a `Tx`

---

Line range hint 85-85: Simplify the phrase for better readability.

- in order to be processed
+ to be processed

---

Line range hint 105-105: Ensure the sentence is complete by adding a subject.

- `ValidateBasic` should not be used anymore.
+ The `ValidateBasic` method should not be used anymore.

---

Line range hint 109-109: Consider using a more specific term than "often".

- are in practice very often used
+ are commonly used

---

Line range hint 111-111: Simplify the phrase for clarity.

- and revert back to the original
+ and revert to the original

---

Line range hint 116-116: Correct the verb form for grammatical accuracy.

- If a transaction embed multiple messages
+ If a transaction embeds multiple messages

---

Line range hint 121-121: Correct the verb form for grammatical accuracy.

- `gas-prices` is greater than their locally defined `min-gas-prices`
+ `gas-prices` are greater than their locally defined `min-gas-prices`

---

Line range hint 131-131: Consider removing "of" for conciseness.

- to encompass all of the transactions
+ to encompass all transactions

---

Line range hint 153-153: Simplify the phrase to enhance readability.

- in order to come to this agreement
+ to reach this agreement

---

Line range hint 155-155: Consider using "among" instead of "amongst" for modern usage.

- One proposer amongst the validators
+ One proposer among the validators

---

Line range hint 220-220: Correct the trailing spaces issue.

- stage    and a malicious proposer may have included invalid ones.
+ stage and a malicious proposer may have included invalid ones.

---

Line range hint 225-225: Correct the loose punctuation mark.

- **`MsgServiceRouter`:** After `CheckTx` exits, `FinalizeBlock`
+ **`MsgServiceRouter`** After `CheckTx` exits, `FinalizeBlock`

---

Line range hint 236-236: Correct the preposition for grammatical accuracy.

- `GasUsed` is set and returned in the `abci.ExecTxResult`
+ `GasUsed` is set and returned to the `abci.ExecTxResult`

---

Line range hint 247-247: Simplify the phrase to enhance readability.

- in order to validate the transactions
+ to validate the transactions

---

Line range hint 249-249: Simplify the phrase for clarity.

- whether or not they should commit the state changes
+ whether they should commit the state changes

---

Line range hint 258-258: Simplify the phrase to enhance readability.

- in order to be consistent and reflect the changes
+ to be consistent and reflect the changes

---

Line range hint 260-260: Correct the comma usage for grammatical accuracy.

- transactions and it is possible for consensus to result
+ transactions, and it is possible for consensus to result

---

Line range hint 261-261: Consider a shorter alternative for conciseness.

- or one with none at all
+ or an empty one

---

Line range hint 266-266: Correct the punctuation usage for grammatical accuracy.

- the transaction lifecycle of a `Tx` is over: nodes have verified its validity
+ the transaction lifecycle of a `Tx` is over; nodes have verified its validity

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5930ee3 and 5ebb105.

Files selected for processing (1)

• docs/learn/beginner/01-tx-lifecycle.md (1 hunks)

Additional Context Used

LanguageTool (24)

docs/learn/beginner/01-tx-lifecycle.md (24)

Near line 35: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scale gas up in order to avoid underestimating. For example, use...
Rule ID: IN_ORDER_TO_PREMIUM

---

Near line 42: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Rule ID: WHETHER

---

Near line 60: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...rd a Tx if it is found to be invalid. Prior to consensus, nodes continuously check inc...
Rule ID: EN_WORDINESS_PREMIUM_PRIOR_TO

---

Near line 77: Consider a shorter alternative to avoid wordiness.
Context: ...need a copy of the last committed state in order to answer queries - they should not respon...
Rule ID: IN_ORDER_TO_PREMIUM

---

Near line 78: Consider a shorter alternative to avoid wordiness.
Context: ... using state with uncommitted changes. In order to verify a Tx, full-nodes call `CheckTx...
Rule ID: IN_ORDER_TO_PREMIUM

---

Near line 85: Consider a shorter alternative to avoid wordiness.
Context: ...]byte form and needs to be unmarshaled in order to be processed. Then, the [runTx`](../ad...
Rule ID: IN_ORDER_TO_PREMIUM

---

Near line 105: To form a complete sentence, be sure to include a subject.
Context: ...y. ::: #### Guideline ValidateBasic should not be used anymore. Message validation...
Rule ID: MISSING_IT_THERE

---

Near line 109: Consider replacing ‘often’ with a more meaningful word.
Context: ...n though optional, are in practice very often used to perform signature verification,...
Rule ID: VERY_RB_STYLE

---

Near line 111: Consider using just “revert”.
Context: ...modifying the last committed state, and revert back to the original if the execution fails....
Rule ID: RETURN_BACK

---

Near line 116: “Transaction” is a singular noun. It appears that the verb form is incorrect.
Context: ... run on a transaction. If a transaction embed multiple messages (like some x/authz, x...
Rule ID: PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT

---

Near line 121: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...ck that the user-specified gas-prices is greater than their locally defined `min...
Rule ID: AI_HYDRA_LEO_CPT_IS_ARE

---

Near line 131: Consider removing “of” to be more concise
Context: ...ache_size` is large enough to encompass all of the transactions in the full mempool. If th...
Rule ID: ALL_OF_THE

---

Near line 143: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ll possible to be found invalid later on, because CheckTx does not fully validate the t...
Rule ID: COMMA_BEFORE_BECAUSE

---

Near line 153: Consider a shorter alternative to avoid wordiness.
Context: ...using ABCI requests to the application, in order to come to this agreement. The first step...
Rule ID: IN_ORDER_TO_PREMIUM

---

Near line 155: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...is the block proposal. One proposer amongst the validators is chosen by the consens...
Rule ID: AMONGST

---

Near line 220: Possible missing comma found.
Context: ...sactions during the addition to Mempool stage and a malicious proposer may have in...
Rule ID: AI_HYDRA_LEO_MISSING_COMMA

---

Near line 225: Loose punctuation mark.
Context: ...inistic results. * MsgServiceRouter: After CheckTx exits, `FinalizeBlock...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 236: The usual collocation for “returned” is “to”, not “in”.
Context: ...ecution completes, GasUsed is set and returned in the abci.ExecTxResult. If execution...
Rule ID: RETURN_IN_THE

---

Near line 247: Consider a shorter alternative to avoid wordiness.
Context: ...ous step of executing state transitions in order to validate the transactions, then sign th...
Rule ID: IN_ORDER_TO_PREMIUM

---

Near line 249: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...te - but listen for votes to understand whether or not they should commit the state changes. ...
Rule ID: WHETHER

---

Near line 258: Consider a shorter alternative to avoid wordiness.
Context: ...tate and deliverState resets to nil in order to be consistent and reflect the changes. ...
Rule ID: IN_ORDER_TO_PREMIUM

---

Near line 260: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...cks have the same number of transactions and it is possible for consensus to result ...
Rule ID: COMMA_COMPOUND_SENTENCE

---

Near line 261: ‘none at all’ might be wordy. Consider a shorter alternative.
Context: ... to result in a nil block or one with none at all. In a public blockchain network, it is ...
Rule ID: EN_WORDINESS_PREMIUM_NONE_AT_ALL

---

Near line 266: Do not use a colon (:) before a series that is introduced by a preposition (‘over’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ... the transaction lifecycle of a Tx is over: nodes have verified its validity, deliv...
Rule ID: RP_COLON

Markdownlint (4)

docs/learn/beginner/01-tx-lifecycle.md (4)

91: Expected: 0 or 2; Actual: 1
Trailing spaces

---

162: Expected: 0 or 2; Actual: 1
Trailing spaces

---

163: Expected: 0 or 2; Actual: 1
Trailing spaces

---

220: Expected: 0 or 2; Actual: 1
Trailing spaces

Path-based Instructions (1)

docs/learn/beginner/01-tx-lifecycle.md (1)

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

Additional comments not posted (1)

docs/learn/beginner/01-tx-lifecycle.md (1)

167-205: The diagram has been reformatted to use consistent spacing, aligning with the rest of the documentation.

[julienrbrt]

@Mergifyio backport release/v0.50.x

[mergify]

backport release/v0.50.x

✅ Backports have been created

• #20460 docs: update diagram to be shown properly (backport #20454) has been created for branch release/v0.50.x but encountered conflicts