docs: updates to abci documentation

[samricotta]

Description

It was requested to make these small changes for the ABCI docs, the conversation can be seen here

@adizere

---

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
  • Clarified and refined the language in the ABCI introduction to improve understanding.
  • Enhanced the explanation of the PrepareProposal process and its importance.
  • Provided detailed insights on the ProcessProposal module, including validator actions and failure scenarios.
  • Updated terminology from "ABCI++" to "ABCI2.0" in the context of vote extensions.

[coderabbitai]

Walkthrough

The updates focus on refining the documentation and functionality of the ABCI (Application Blockchain Interface), enhancing clarity and precision across several aspects. Changes include clearer language in the introduction, a functional tweak in proposal preparation, detailed explanation on proposal processing, and a semantic update in vote extensions. These modifications aim to improve the understanding and implementation of ABCI without altering its core logic.

Changes

File(s)	Summary of Changes
docs/build/abci/00-introduction.md	Clarifications and refinements in language to better describe ABCI and its methods.
docs/build/abci/01-prepare-proposal.md	Modified prepareOpt function for better clarity in PrepareProposalHandler method invocation.
docs/build/abci/02-process-proposal.md	Elaborated on validators' rights to accept or reject a block proposal and the subsequent process if rejected.
docs/build/abci/03-vote-extensions.md	Updated the version reference from "ABCI++" to "ABCI2.0 (colloquially called ABCI++)" in the context of extending a pre-commit vote, reflecting a semantic rather than functional change.

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 27d99d1 and fcd976f.

Files selected for processing (4)

• docs/build/abci/00-introduction.md (3 hunks)
• docs/build/abci/01-prepare-proposal.md (1 hunks)
• docs/build/abci/02-process-proposal.md (2 hunks)
• docs/build/abci/03-vote-extensions.md (1 hunks)

Files skipped from review due to trivial changes (3)

• docs/build/abci/00-introduction.md
• docs/build/abci/02-process-proposal.md
• docs/build/abci/03-vote-extensions.md

Additional comments: 1

docs/build/abci/01-prepare-proposal.md (1)

• 37-44: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-41]

The documentation provides a clear explanation of the PrepareProposal phase within the Cosmos SDK's ABCI documentation. However, ensure that all technical terms and code references are accurate and up-to-date with the latest Cosmos SDK versions to maintain the documentation's reliability and usefulness for developers.