[docs] chore: add motivation and faq in docs and readme - #51
Conversation
Summary of ChangesHello @Wangmerlyn, 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 improving the clarity and comprehensiveness of the project's documentation. It provides better context for the tool's existence, offers more practical usage examples for both command-line and Python API, and addresses potential user questions through a new FAQ section. These changes aim to make it significantly easier for new and existing users to understand and effectively utilize KeepGPU. 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 significantly improves the project's documentation by restructuring the README.md and adding a motivation section, quick start guide, and clearer examples. It also adds an FAQ to the CLI guide and other helpful tips. The changes make the project's purpose and usage much clearer for new users. I have one minor suggestion to improve code formatting in the README.
No description provided.