Skip to content

📝 Add link to CLI Reference in README#2394

Merged
ChanTsune merged 1 commit into
mainfrom
docs/README
Dec 1, 2025
Merged

📝 Add link to CLI Reference in README#2394
ChanTsune merged 1 commit into
mainfrom
docs/README

Conversation

@ChanTsune
Copy link
Copy Markdown
Owner

Added a reference to the CLI documentation in the README to help users find detailed command information more easily.

Added a reference to the CLI documentation in the README to help users find detailed command information more easily.
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @ChanTsune, 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 improves the project's documentation accessibility by adding a direct link to the CLI Reference within the main README.md file. This ensures that users can quickly and easily locate comprehensive information regarding command-line usage, streamlining their experience with the project.

Highlights

  • Documentation Update: A direct link to the CLI Reference documentation has been added to the README.md file.
  • Improved User Experience: This change makes it easier for users to find detailed command information, enhancing the overall usability of the project.
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
Copy Markdown
Contributor

@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 adds a helpful link to the CLI reference documentation in the README. My review suggests changing the relative link to an absolute URL to ensure it works correctly across different platforms where the README might be displayed, which improves the robustness of the documentation.

Comment thread README.md
@ChanTsune ChanTsune merged commit 0795b48 into main Dec 1, 2025
98 of 99 checks passed
@ChanTsune ChanTsune deleted the docs/README branch December 1, 2025 09:24
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