docs(cometbft): update ABCI links #116
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the ABCI documentation links across the CometBFT ABCI docs to reference the latest v1.0 documentation. It also adds version-specific notes for methods that are only applicable for CometBFT versions prior to v0.38.0.
Reviewed Changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| cometbft/src/abci/doc/response-verifyvoteextension.md | Updated ABCI documentation link from v0.38.x GitHub reference to v1.0 docs. |
| cometbft/src/abci/doc/response-query.md | Updated ABCI docs link to v1.0; note potential URL structure change for the query endpoint. |
| cometbft/src/abci/doc/response-processproposal.md | Updated ABCI docs link from v0.37.x to v1.0. |
| cometbft/src/abci/doc/response-prepareproposal.md | Updated ABCI docs link from v0.37.x to v1.0. |
| cometbft/src/abci/doc/response-offersnapshot.md | Updated both the primary ABCI docs link and the state sync (ssd) link to v1.0. |
| cometbft/src/abci/doc/response-loadsnapshotchunk.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-listsnapshots.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-initchain.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-info.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-flush.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-finalizeblock.md | Updated ABCI docs link from v0.38.x GitHub reference to v1.0. |
| cometbft/src/abci/doc/response-extendvote.md | Updated ABCI docs link from v0.38.x GitHub reference to v1.0. |
| cometbft/src/abci/doc/response-endblock.md | Added a version-specific note and updated the ABCI docs link to reference v0.37 for backwards compatibility. |
| cometbft/src/abci/doc/response-echo.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-delivertx.md | Added a version-specific note and updated the ABCI docs link to v0.37 for pre-v0.38 methods. |
| cometbft/src/abci/doc/response-commit.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-checktx.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/response-beginblock.md | Added a version-specific note and updated the ABCI docs link to v0.37 for pre-v0.38 methods. |
| cometbft/src/abci/doc/response-applysnapshotchunk.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-verifyvoteextension.md | Updated ABCI docs link from v0.38.x GitHub reference to v1.0. |
| cometbft/src/abci/doc/request-query.md | Updated ABCI docs link to v1.0; review the URL pattern for consistency with endpoint updates. |
| cometbft/src/abci/doc/request-processproposal.md | Updated ABCI docs link from v0.37.x to v1.0. |
| cometbft/src/abci/doc/request-prepareproposal.md | Updated ABCI docs link from v0.37.x to v1.0. |
| cometbft/src/abci/doc/request-offersnapshot.md | Updated both the primary ABCI docs link and the ssd reference to v1.0. |
| cometbft/src/abci/doc/request-loadsnapshotchunk.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-listsnapshots.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-initchain.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-info.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-flush.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-finalizeblock.md | Updated ABCI docs link from v0.38.x GitHub reference to v1.0. |
| cometbft/src/abci/doc/request-extendvote.md | Updated ABCI docs link from v0.38.x GitHub reference to v1.0. |
| cometbft/src/abci/doc/request-endblock.md | Added a version-specific note and updated the ABCI docs link to reference v0.37 for pre-v0.38 methods. |
| cometbft/src/abci/doc/request-echo.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-delivertx.md | Added a version-specific note and updated the ABCI docs link to v0.37 for pre-v0.38 methods. |
| cometbft/src/abci/doc/request-commit.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-checktx.md | Updated ABCI docs link to v1.0. |
| cometbft/src/abci/doc/request-beginblock.md | Added a version-specific note and updated the ABCI docs link to v0.37 for pre-v0.38 methods. |
| cometbft/src/abci/doc/request-applysnapshotchunk.md | Updated ABCI docs link to v1.0. |
Comments suppressed due to low confidence (3)
cometbft/src/abci/doc/response-query.md:3
- Verify that the updated URL for the 'query' endpoint using 'abci++_methods' is correct for v1.0 documentation, as the query endpoint might follow a different URL structure.
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#query)
cometbft/src/abci/doc/response-endblock.md:3
- Confirm that the version-specific note and the accompanying documentation link (pointing to v0.37) for 'endblock' correctly reflect the intended backward compatibility and documentation structure.
**This is only called by CometBFT prior to version v0.38.0.**
cometbft/src/abci/doc/response-delivertx.md:4
- Ensure that the version-specific note and the updated documentation link (targeting v0.37) for 'delivertx' align with the intended use of this endpoint in pre-v0.38 versions.
**This is only called by CometBFT prior to version v0.38.0.**
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the ABCI documentation links across multiple files in the
cometbft/src/abci/docdirectory to point to the latest version (v1.0) of the CometBFT documentation. Additionally, it adds version-specific notes for methods that are only applicable to CometBFT versions prior to v0.38.0.