Conversation
|
The latest Buf updates on your PR. Results from workflow CI and Release / buf-check (pull_request).
|
There was a problem hiding this comment.
Summary of Changes
Hello @pthmas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses outdated documentation guides following a rebranding effort and the merging of documentation into the ev-node repository. The core purpose is to ensure all tutorials and examples reflect the current state of the project. This involves updating command-line flag prefixes from --evolve to --evnode and revising the installation procedures for the local Data Availability network, providing users with accurate and up-to-date instructions for interacting with the system.
Highlights
- Consistent Flag Renaming: The primary change across multiple documentation files is the renaming of command-line flags from the
--evolveprefix to--evnode. This affects various parameters related to node aggregation, data availability configuration (e.g.,start_height,auth_token,namespace,block_time), and EVM settings. - Updated Local DA Installation Process: The instructions for setting up and running the local Data Availability (DA) network have been updated. Instead of using a
curlscript, users are now guided togit clonetheev-noderepository, build the DA binary usingmake build-da, and then execute it directly. - Version Updates in Documentation Examples: Several documentation snippets, particularly in
docs/guides/gm-world.mdanddocs/guides/quick-start.md, have been updated to reflect newer versions of tools like Ignite CLI, Cosmos SDK, and Go, ensuring the guides remain current with the development environment.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to align with the rebranding from evolve to evnode and refines the setup instructions for the local Data Availability (DA) layer. The changes are generally good and improve clarity. I've identified a recurring issue across multiple guides where the instructions for running the local DA could be clearer about terminal management, as the new command is a blocking process. My feedback focuses on enhancing these instructions for a better user experience.
Overview
With the rebranding and the merging of the docs into the ev-node repo, some tutorials were not up to date anymore. This PR aims at fixing some of those issues.