Skip to content

Conversation

@kmoscoe
Copy link
Contributor

@kmoscoe kmoscoe commented Dec 3, 2025

No description provided.

@kmoscoe kmoscoe requested a review from keyurva December 3, 2025 23:11
@gemini-code-assist
Copy link

Summary of Changes

Hello @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 run_tools.md documentation. It introduces platform-specific instructions for setting environment variables, ensures external links open in new tabs, and refines the prerequisites for various tools, making the guide more comprehensive and user-friendly.

Highlights

  • Windows Command Support: Introduced a dedicated Windows Powershell command for setting the DC_API_KEY environment variable, presented within a new tabbed UI for better platform-specific instructions.
  • External Link Behavior: Modified all external links across the document to open in a new browser tab, improving user experience by preventing navigation away from the current page.
  • Updated Prerequisites: Enhanced the clarity and completeness of prerequisites for the Gemini CLI by explicitly listing Node.js as a requirement and updating the installation link.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a 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.

Comment on lines +87 to +89
- <code>DC_API_KEY="<var>YOUR API KEY</var>"</code>
- `DC_TYPE="custom"`
- <code>CUSTOM_DC_URL="<var>YOUR_INSTANCE_URL</var>"</code>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

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.

Suggested change
- <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>

Comment on lines +46 to +47
- 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"}.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
- 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"}.

Comment on lines +72 to +78
<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>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
<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>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The file ends without a final newline character. It's a standard convention to end text files with a newline to avoid issues with some tools and systems.

Suggested change
<script src="/assets/js/customdc-doc-tabs.js"></script>
<script src="/assets/js/customdc-doc-tabs.js"></script>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant