Skip to content

docs(cometbft): update ABCI and data structure links#117

Open
melekes wants to merge 2 commits intomainfrom
cometbft-abci-doc-2
Open

docs(cometbft): update ABCI and data structure links#117
melekes wants to merge 2 commits intomainfrom
cometbft-abci-doc-2

Conversation

@melekes
Copy link
Copy Markdown
Collaborator

@melekes melekes commented Jun 30, 2025

No description provided.

@melekes melekes self-assigned this Jun 30, 2025
@melekes melekes requested a review from Copilot June 30, 2025 09:34
@melekes melekes added the documentation Improvements or additions to documentation label Jun 30, 2025
@melekes melekes mentioned this pull request Jun 30, 2025
7 tasks
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the documentation links and embeds external markdown documentation into various modules to align with the new CometBFT docs.

  • Updated outdated Tendermint and old CometBFT links to new URLs under the v1.0 spec.
  • Replaced inline documentation with external markdown includes in selected ABCI request files.

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

Show a summary per file
File Description
cometbft/src/vote.rs Updated the vote data structure documentation link.
cometbft/src/consensus/params.rs Updated the ABCI documentation link reference for consensus parameters.
cometbft/src/block/id.rs Updated the block ID documentation link.
cometbft/src/block/header.rs Updated the header documentation link.
cometbft/src/block/commit.rs Removed outdated TODO links and updated the commit documentation link.
cometbft/src/block.rs Updated the block structure documentation link.
cometbft/src/abci/types.rs Removed the outdated ABCI documentation comment.
cometbft/src/abci/response/finalize_block.rs Introduced external markdown documentation for finalizing blocks.
cometbft/src/abci/request/init_chain.rs Replaced inline documentation with external markdown; a stray '#' line is present.
cometbft/src/abci/request/apply_snapshot_chunk.rs Introduced external markdown documentation via include_str!.
cometbft/src/abci/request.rs Cleared repeated comment blocks for cleaner documentation.
cometbft/src/abci/event.rs Updated the events documentation link to the new URL.
cometbft/src/abci/code.rs Updated the error-returning documentation link to the new URL.
cometbft/src/abci.rs Updated the ABCI module documentation link to the new URL with updated methods.
Comments suppressed due to low confidence (1)

cometbft/src/abci/request/init_chain.rs:5

  • The line containing only '#' appears to be extraneous. Consider removing it to ensure the documentation is formatted correctly.
#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants