Skip to content

Conversation

@fadeev
Copy link
Member

@fadeev fadeev commented Oct 2, 2025

Summary by CodeRabbit

Release Notes

  • Documentation
    • Expanded CCTX docs with detailed CLI examples for querying transactions across outbound, inbound, abort, and revert scenarios.
    • Clarified gas-fee example by updating the command usage for consistency.
    • Added a CLI example for querying ZRC-20 token listings.

@vercel
Copy link

vercel bot commented Oct 2, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
docs-v2 Ready Ready Preview Nov 10, 2025 11:01am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025

📝 Walkthrough

Walkthrough

Documentation-only updates to three EVM developer pages: added extensive CLI examples for querying CCTX hashes (various cases), reformatted and simplified the gas fees query command, and added a ZRC-20 token list CLI example. No code or data-structure changes.

Changes

Cohort / File(s) Summary
CCTX CLI Examples
src/pages/developers/evm/cctx.mdx
Added multiple CLI examples and command output snippets demonstrating zetachain query cctx --hash <hash> for outbound, inbound, aborted, reverted, and multiple outgoing CCTX scenarios; inserted detailed transaction dumps and status/error fields.
Gas CLI Formatting
src/pages/developers/evm/gas.mdx
Reflowed a sentence for readability and changed the example invocation from npx zetachain query fees to zetachain query fees.
ZRC-20 Token Query
src/pages/developers/evm/zrc20.mdx
Added a short section showing the CLI command zetachain query tokens list to list ZRC-20 tokens.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Documentation-only, additive content with minor formatting changes
  • Focus review on correctness and accuracy of CLI examples and copied outputs:
    • src/pages/developers/evm/cctx.mdx — verify example hashes, status labels, and error text formatting
    • src/pages/developers/evm/gas.mdx — confirm command change is intentional (remove npx)
    • src/pages/developers/evm/zrc20.mdx — confirm command and heading placement

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly captures the main objective of the pull request: augmenting documentation with additional CLI usage examples across multiple pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-cli

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 98aa676 and 3eb92a0.

📒 Files selected for processing (1)
  • src/pages/developers/evm/gas.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
🔇 Additional comments (1)
src/pages/developers/evm/gas.mdx (1)

71-72: CLI command simplification is well executed.

The change from npx zetachain query fees to zetachain query fees is a clean, direct invocation that improves clarity and aligns with the PR's objective to emphasize CLI usage in documentation.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • ZRC-20: Authentication required, not authenticated - You need to authenticate to access this operation.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@fadeev fadeev marked this pull request as ready for review November 10, 2025 10:41
@fadeev fadeev requested review from a team as code owners November 10, 2025 10:41
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/pages/developers/evm/cctx.mdx (1)

57-82: Consider maintenance strategy for CLI output examples.

These CLI output examples provide immense value but should be monitored to ensure they remain representative of actual command output as the CLI evolves. Consider documenting how often these examples are validated or establishing a process for keeping them current with CLI changes.

Also applies to: 108-122, 144-166, 197-228

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between bf12213 and 98aa676.

📒 Files selected for processing (3)
  • src/pages/developers/evm/cctx.mdx (4 hunks)
  • src/pages/developers/evm/gas.mdx (1 hunks)
  • src/pages/developers/evm/zrc20.mdx (1 hunks)
🔇 Additional comments (2)
src/pages/developers/evm/zrc20.mdx (1)

57-61: Well-placed CLI usage example.

The addition provides clear, practical guidance for querying ZRC-20 tokens via the CLI. The placement and formatting are consistent with the PR's objective to enhance CLI documentation across developer guides.

src/pages/developers/evm/cctx.mdx (1)

57-82: Comprehensive CLI documentation with practical examples.

The additions provide extensive, well-structured CLI examples across multiple CCTX scenarios: incoming & outgoing transactions, abort cases, revert scenarios, and multiple outgoing CCTXs. Each example demonstrates the command invocation and resulting output, offering clear guidance for developers tracking cross-chain transactions.

Also applies to: 108-122, 144-166, 197-228

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants