Skip to content

docs: fix typos and improve clarity in README#25200

Closed
Guru6446 wants to merge 1 commit intogoogle-gemini:mainfrom
Guru6446:docs-fix-readme-typo
Closed

docs: fix typos and improve clarity in README#25200
Guru6446 wants to merge 1 commit intogoogle-gemini:mainfrom
Guru6446:docs-fix-readme-typo

Conversation

@Guru6446
Copy link
Copy Markdown

Description

Fixed typos and improved clarity in the README documentation.

Changes

  • Fixed spelling and grammar issues
  • Improved formatting for better readability
  • Enhanced clarity of instructions

Type of Change

  • Documentation update
  • Bug fix
  • New feature

This is a documentation-only change with no code modifications.

- Fixed spelling errors
- Improved formatting
- Enhanced clarity of instructions
@Guru6446 Guru6446 requested review from a team as code owners April 12, 2026 07:22
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 exclusively on improving the quality and accuracy of the project's documentation. By refining existing text and removing outdated elements, the changes ensure that the README remains a reliable and clear resource for users.

Highlights

  • Documentation Cleanup: Removed an obsolete badge from the README file.
  • Clarity Improvements: Updated text descriptions for IDE integration to improve readability and corrected link formatting in the Legal section.
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.

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 removes the Code Wiki badge and updates several links and descriptions in the README. However, the edits to the 'IDE Integration' and 'License' sections inadvertently deleted the 'Sandboxing & Security' and 'Terms of Service' headers, resulting in duplicate entries and orphaned descriptions that need to be restored.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread README.md
Comment on lines 317 to 319
- [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - VS
Code companion.
- [**Sandboxing & Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe
- [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - Visual Studio Code companion.
execution environments.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

The update to the 'IDE Integration' description has accidentally overwritten the 'Sandboxing & Security' section header and duplicated the 'IDE Integration' entry. This results in broken documentation where the sandboxing description is orphaned. Please maintain consistency in documentation as per the repository guidelines.

Suggested change
- [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - VS
Code companion.
- [**Sandboxing & Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe
- [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - Visual Studio Code companion.
execution environments.
- [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - Visual Studio Code companion.
- [**Sandboxing & Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe
execution environments.
References
  1. Maintain consistency in documentation. When information about a feature is present in multiple documents, ensure all instances are updated or removed together to avoid contradictions.

Comment thread README.md
Comment on lines 389 to 391
- **License**: [Apache License 2.0](LICENSE)
- **Terms of Service**:
- **License**: [Apache License 2.0](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)
[Terms & Privacy](https://www.geminicli.com/docs/resources/tos-privacy)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

The 'Terms of Service' label was replaced by a duplicate 'License' entry. This causes the 'Terms & Privacy' link to be incorrectly associated and creates redundant information. Please maintain consistency in documentation as per the repository guidelines.

Suggested change
- **License**: [Apache License 2.0](LICENSE)
- **Terms of Service**:
- **License**: [Apache License 2.0](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)
[Terms & Privacy](https://www.geminicli.com/docs/resources/tos-privacy)
- **License**: [Apache License 2.0](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)
- **Terms of Service**:
[Terms & Privacy](https://www.geminicli.com/docs/resources/tos-privacy)
References
  1. Maintain consistency in documentation. When information about a feature is present in multiple documents, ensure all instances are updated or removed together to avoid contradictions.

@gemini-cli gemini-cli Bot added the status/need-issue Pull requests that need to have an associated issue. label Apr 12, 2026
@gemini-cli
Copy link
Copy Markdown
Contributor

gemini-cli Bot commented Apr 27, 2026

Hi there! Thank you for your interest in contributing to Gemini CLI.

To ensure we maintain high code quality and focus on our prioritized roadmap, we have updated our contribution policy (see Discussion #17383).

We only guarantee review and consideration of pull requests for issues that are explicitly labeled as 'help wanted'. All other community pull requests are subject to closure after 14 days if they do not align with our current focus areas. For this reason, we strongly recommend that contributors only submit pull requests against issues explicitly labeled as 'help-wanted'.

This pull request is being closed as it has been open for 14 days without a 'help wanted' designation. We encourage you to find and contribute to existing 'help wanted' issues in our backlog! Thank you for your understanding and for being part of our community!

@gemini-cli gemini-cli Bot closed this Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status/need-issue Pull requests that need to have an associated issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant