fix: Update paths in example READMEs and move the READMEs to the client and server dirs #148
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @fjuma, 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 focuses on improving the clarity and accuracy of the project's example documentation. It reorganizes the helloworld example README files by moving them to more intuitive locations and updates all relevant internal and external paths to ensure users can easily follow the instructions for setting up and running the client and server examples.
Highlights
- Documentation Structure Reorganization: The
README.mdfiles for thehelloworldclient and server examples have been logically moved into their respectiveclientandserverdirectories withinexamples/helloworld. This improves the organization and discoverability of example documentation. - Path Corrections in Documentation: The main
README.mdhas been updated to reflect the new locations of the example READMEs. Additionally, internalcdcommand paths within theexamples/helloworld/client/README.mdandexamples/helloworld/server/README.mdfiles have been corrected to ensure accurate navigation instructions for users.
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 is currently in preview and 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 to provide feedback.
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. ↩
README.md
Outdated
| ### Hello World Example | ||
|
|
||
| A complete example of an A2A client communicating with a Python A2A server is available in the [examples/helloworld](examples/helloworld) directory. This example demonstrates: | ||
| A complete example of an A2A client communicating with a Python A2A server is available in the [examples/helloworld/server](examples/helloworld/server/README.md) directory. This example demonstrates: |
There was a problem hiding this comment.
The link points to the server example's README, but the description is about the client example. This could confuse users.
| A complete example of an A2A client communicating with a Python A2A server is available in the [examples/helloworld/server](examples/helloworld/server/README.md) directory. This example demonstrates: | |
| A complete example of an A2A client communicating with a Python A2A server is available in the [examples/helloworld/client](examples/helloworld/client/README.md) directory. This example demonstrates: |
| 2. Navigate to the example directory: | ||
| ```bash | ||
| cd examples/client/src/main/java/io/a2a/examples/helloworld | ||
| cd examples/helloworld/client/src/main/java/io/a2a/examples/helloworld/ | ||
| ``` |
There was a problem hiding this comment.
The cd command navigates into a very deep directory. A simpler approach is to run jbang with the full path to the script from the project root, avoiding the cd command entirely.
| 2. Navigate to the example directory: | |
| ```bash | |
| cd examples/client/src/main/java/io/a2a/examples/helloworld | |
| cd examples/helloworld/client/src/main/java/io/a2a/examples/helloworld/ | |
| ``` | |
| 2. Run the client from the project root using JBang: | |
| ```bash | |
| jbang examples/helloworld/client/src/main/java/io/a2a/examples/helloworld/HelloWorldRunner.java |
…nt and server dirs
2 participants
Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
CONTRIBUTINGGuide.fix:which represents bug fixes, and correlates to a SemVer patch.feat:represents a new feature, and correlates to a SemVer minor.feat!:, orfix!:,refactor!:, etc., which represent a breaking change (indicated by the!) and will result in a SemVer major.