Fix/replace okp4 by axone #649
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Note Reviews pausedUse the following commands to manage reviews:
WalkthroughThe pull request introduces documentation updates for the Okp4/Axone blockchain project. The changes primarily focus on renaming the Command Line Interface (CLI) from Changes
Possibly related PRs
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/tutorials/cli-1.mdx (2)
27-31: Consider enhancing the version compatibility warning.The caution note about version compatibility is crucial for preventing runtime issues. Consider:
- Making it more prominent by moving it before the installation steps
- Adding a command to check the network's version before installation
+### Check network version first + +Before installation, verify the network version: + +```bash +curl -s https://explore.axone.xyz/api/v1/axone%20testnet/params | jq '.params[] | select(.param == "version")' +``` + ### `axoned` one-liner installer script :::caution The following installation procedure targets the latest released version of the axoned CLI, which may be ahead of the version currently supported by the targeted network. To ensure compatibility, make sure to install the version that matches the network's version. You can verify the correct version by checking the parameters of the network on the [Axone testnet explorer](https://explore.axone.xyz/Axone%20testnet/params). :::
413-419: Enhance documentation with cross-references.The recap section could be more valuable by:
- Adding links to related documentation sections
- Including references to troubleshooting guides
## Recap' - The CLI allows you to communicate with the Axone blockchain - - To get started, you should install the `axoned` CLI and create (or import) a wallet + - To get started, you should [install the `axoned` CLI](#installing-the-axone-cli) and [create (or import) a wallet](#get-a-wallet-by-creating-a-new-key-pair) - Both native and smart contracts transactions are supported We've just scratched the surface of what's possible with the Axone CLI! For a more detailed look at available commands, please check our full documentation at [Axone Documentation](https://docs.axone.xyz/commands/axoned). + +For common issues and solutions, refer to our [Troubleshooting Guide](https://docs.axone.xyz/troubleshooting). Remember, the blockchain space moves quickly, and Axone is no exception. Stay in touch with our updates and feel free to join our active developer community. We're thrilled to have you on board!🧰 Tools
🪛 LanguageTool
[style] ~419-~419: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...ion. Stay in touch with our updates and feel free to join our active developer community. We...(FEEL_FREE_TO_STYLE_ME)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/nodes/installation.mdx(2 hunks)docs/tutorials/cli-1.mdx(15 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/nodes/installation.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: lint-web
- GitHub Check: lint-commits
- GitHub Check: build-yarn
There was a problem hiding this comment.
| Device | URL |
|---|---|
| desktop | http://localhost:3000/ |
| Device | URL |
|---|---|
| mobile | http://localhost:3000/ |
Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/tutorials/cli-1.mdx (2)
34-34: Add checksum verification step for binary downloads.For security best practices, consider adding instructions to verify the downloaded binary's checksum.
+ # Verify the binary checksum + echo "<expected_checksum> axoned" | sha256sum -c
127-128: Add denomination explanation for clarity.Consider adding a note explaining the denomination conversion: 1 AXON = 1,000,000 uAXON (micro-AXON).
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/tutorials/cli-1.mdx(15 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/tutorials/cli-1.mdx
[uncategorized] ~117-~117: Possible missing comma found.
Context: ...vm8WkkoPLQR03JN"}' type: local ' ``` Here the terminal returns `axone1cu9wzlcyyxp...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: lint-web
- GitHub Check: build-yarn
- GitHub Check: lint-commits
🔇 Additional comments (2)
docs/tutorials/cli-1.mdx (2)
174-175: Update example transaction hash.The transaction hash
4DB4644E6146DE0E7239C5273F79C931193F542D62979ACB907C9368A315DCE1is invalid on the Axone network. Please replace it with a valid transaction hash or add a note indicating it's a placeholder.Also applies to: 196-197
Line range hint
1-417: Overall changes look good!The rebranding from OKP4 to Axone has been implemented consistently throughout the documentation. The structure is clear, and examples are well-formatted.
|
@coderabbitai pause |
✅ Actions performedReviews paused. |
ccamel
force-pushed
the
fix/replace-okp4-by-axone
branch
from
36290b4 to
7f81921
Compare
|
@coderabbitai resolve |
✅ Actions performedComments resolved. |
Updates the CLI installation guide to replace references to OKP4 with Axone.
+ cosmetic
Note: the tutorial is now quite outdated, and some of the described commands likely no longer work. We’ll need to review the content to ensure everything is up to date.
Summary by CodeRabbit
Documentation
okp4dtoaxoned.okp4prefix toaxoneprefix.Chores