-
Notifications
You must be signed in to change notification settings - Fork 153
Mention CLI more in the docs #745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation-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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
⏰ 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)
🔇 Additional comments (1)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
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. Comment |
There was a problem hiding this 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.
📒 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
Summary by CodeRabbit
Release Notes