-
Notifications
You must be signed in to change notification settings - Fork 36
Add a Windows command and add tags for outlinks #660
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: master
Are you sure you want to change the base?
Conversation
Co-authored-by: Christie Ellks <[email protected]>
Co-authored-by: Christie Ellks <[email protected]>
Summary of ChangesHello @kmoscoe, 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 primarily focuses on improving the user experience and clarity of the Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
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.
Code Review
This pull request updates the run_tools.md documentation by adding commands for Windows, including target="_blank" for external links to improve user experience, and reorganizing some sections for better clarity. My review focuses on ensuring the accuracy of the new commands and the correctness of the markdown syntax. I have identified a few areas for improvement, including correcting the markdown for external links, cleaning up HTML formatting in code blocks, addressing an issue with environment variable examples that could impact functionality for shell users, and a minor style concern regarding the end of the file. Overall, these changes enhance the documentation, and with the suggested adjustments, it will be even more effective.
| - <code>DC_API_KEY="<var>YOUR API KEY</var>"</code> | ||
| - `DC_TYPE="custom"` | ||
| - <code>CUSTOM_DC_URL="<var>YOUR_INSTANCE_URL</var>"</code> |
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.
The export keyword has been removed from these environment variable examples. While this is correct for .env files, it's incorrect for users who set these variables directly in their shell, which is another supported method mentioned earlier. This could lead to the tools not working correctly for those users. It would be better to keep the export keyword for the general case and add a note in the .env file section that it should be omitted there.
| - <code>DC_API_KEY="<var>YOUR API KEY</var>"</code> | |
| - `DC_TYPE="custom"` | |
| - <code>CUSTOM_DC_URL="<var>YOUR_INSTANCE_URL</var>"</code> | |
| - <code>export DC_API_KEY="<var>YOUR API KEY</var>"</code> | |
| - `export DC_TYPE="custom"` | |
| - <code>export CUSTOM_DC_URL="<var>YOUR_INSTANCE_URL</var>"</code> |
| - A (free) Data Commons API key. To obtain an API key, go to <https://apikeys.datacommons.org>{: target="_blank"} and request a key for the `api.datacommons.org` domain. | ||
| - Install `uv` for managing and installing Python packages; see the instructions at <https://docs.astral.sh/uv/getting-started/installation/>{: target="_blank"}. |
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.
The use of {: target="_blank"} with autolinked URLs (e.g., <https://...>) may not be supported by the Markdown parser and might not render as expected. For better compatibility and clarity, it's recommended to use the standard Markdown link format [link text](url). This also provides an opportunity to use more descriptive link text.
| - A (free) Data Commons API key. To obtain an API key, go to <https://apikeys.datacommons.org>{: target="_blank"} and request a key for the `api.datacommons.org` domain. | |
| - Install `uv` for managing and installing Python packages; see the instructions at <https://docs.astral.sh/uv/getting-started/installation/>{: target="_blank"}. | |
| - A (free) Data Commons API key. To obtain an API key, go to [the API key request page](https://apikeys.datacommons.org){: target="_blank"} and request a key for the `api.datacommons.org` domain. | |
| - Install `uv` for managing and installing Python packages; see the [installation instructions](https://docs.astral.sh/uv/getting-started/installation/){: target="_blank"}. |
| <pre> | ||
| export DC_API_KEY="<var>YOUR API KEY</var>"</pre> | ||
| </div> | ||
| <div> | ||
| <pre> | ||
| $env:DC_API_KEY="<var>YOUR API KEY</var>"</pre> | ||
| </div> |
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.
The code examples inside the <pre> tags have leading spaces and are split across lines, which can affect rendering and makes the HTML harder to read. This can be confusing for users who copy and paste these commands. It's best to remove the extra indentation and consolidate the tags for cleaner and more user-friendly code snippets.
| <pre> | |
| export DC_API_KEY="<var>YOUR API KEY</var>"</pre> | |
| </div> | |
| <div> | |
| <pre> | |
| $env:DC_API_KEY="<var>YOUR API KEY</var>"</pre> | |
| </div> | |
| <pre>export DC_API_KEY="<var>YOUR API KEY</var>"</pre> | |
| </div> | |
| <div> | |
| <pre>$env:DC_API_KEY="<var>YOUR API KEY</var>"</pre> | |
| </div> |
|
|
||
| You can connect to the server using [Gemini CLI](#use-gemini-cli) or the [sample ADK agent](#use-the-sample-agent). If you're using a different client from the ones documented on this page, consult its documentation to determine how to specify an HTTP URL. | ||
|
|
||
| <script src="/assets/js/customdc-doc-tabs.js"></script> |
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.
No description provided.