Skip to content

[docs] chore: add motivation and faq in docs and readme - #51

Merged
Wangmerlyn merged 4 commits into
mainfrom
readme-pitch
Nov 25, 2025
Merged

[docs] chore: add motivation and faq in docs and readme#51
Wangmerlyn merged 4 commits into
mainfrom
readme-pitch

Conversation

@Wangmerlyn

Copy link
Copy Markdown
Owner

No description provided.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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

  • Enhanced Documentation: The README.md has been significantly updated to provide a clearer motivation for the project, detailed quick start guides for both CLI and Python API usage, and a comprehensive summary of key features.
  • New FAQ Section: A new Frequently Asked Questions (FAQ) section has been introduced in the CLI guide (docs/guides/cli.md) to address common user questions and provide troubleshooting tips, such as handling NVML availability and running under schedulers.
  • Clarified Power Efficiency: The documentation now explicitly highlights KeepGPU's power-aware operation, explaining that it uses intervalled elementwise operations to maintain GPU activity without high power consumption or spiking thermals.
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.

@gemini-code-assist gemini-code-assist Bot left a comment

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.

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.

@Wangmerlyn
Wangmerlyn merged commit c72d598 into main Nov 25, 2025
4 checks passed
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