Skip to content

docs: fix typos and improve clarity in README #25200

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.

Sign up for GitHub

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

Closed
Guru6446 wants to merge 1 commit into from
Closed

docs: fix typos and improve clarity in README #25200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![Gemini CLI E2E (Chained)](https://github.com/google-gemini/gemini-cli/actions/workflows/chained_e2e.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/chained_e2e.yml)
[![Version](https://img.shields.io/npm/v/@google/gemini-cli)](https://www.npmjs.com/package/@google/gemini-cli)
[![License](https://img.shields.io/github/license/google-gemini/gemini-cli)](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)
[![View Code Wiki](https://assets.codewiki.google/readme-badge/static.svg)](https://codewiki.google/github.com/google-gemini/gemini-cli?utm_source=badge&utm_medium=github&utm_campaign=github.com/google-gemini/gemini-cli)

![Gemini CLI Screenshot](/docs/assets/gemini-screenshot.png)

Expand Down Expand Up @@ -316,8 +315,7 @@ gemini
- [**Headless Mode (Scripting)**](https://www.geminicli.com/docs/cli/headless) -
Use Gemini CLI in automated workflows.
- [**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.
Comment on lines 317 to 319
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Apr 12, 2026

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.

- [**Trusted Folders**](https://www.geminicli.com/docs/cli/trusted-folders) -
Control execution policies by folder.
Expand Down Expand Up @@ -389,7 +387,7 @@ for removal instructions.
## 📄 Legal

- **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)
Comment on lines 389 to 391
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Apr 12, 2026

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.

- **Security**: [Security Policy](SECURITY.md)

Expand Down