make IDE integration generic#13084
Conversation
Summary of ChangesHello @skeshive, 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 on making the documentation for IDE integration more generic and inclusive. It updates 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.
Code Review
This pull request updates the README.md to generalize the description of the IDE integration feature, changing it from a 'VS Code companion' to a more generic 'IDE companion'. While this aligns with the pull request's goal, the change is premature and makes the main README.md inconsistent with the implementation and other documentation, which still state that only VS Code and its forks are supported. This can be misleading for users. I have left a comment detailing this issue.
| automated workflows. | ||
| - [**Architecture Overview**](./docs/architecture.md) - How Gemini CLI works. | ||
| - [**IDE Integration**](./docs/ide-integration/index.md) - VS Code companion. | ||
| - [**IDE Integration**](./docs/ide-integration/index.md) - IDE companion. |
There was a problem hiding this comment.
This change describes the feature as a generic 'IDE companion', which is inconsistent with the current implementation and other documentation files. The feature still appears to be limited to Visual Studio Code. For instance, docs/ide-integration/index.md states, 'Currently, the only supported IDE is Visual Studio Code...'. Similarly, error messages within the CLI code specify support only for 'VS Code or VS Code forks'. This discrepancy is misleading to users and sets incorrect expectations about the feature's capabilities. To ensure documentation accuracy, this change should be accompanied by the full implementation of generic IDE support, or it should be reverted until the feature is truly IDE-agnostic.
Summary
Details
Related Issues
How to Validate
Pre-Merge Checklist