Skip to content

Conversation

@P09s
Copy link

@P09s P09s commented Jan 11, 2026

This PR improves onboarding for new users by:

  • Adding a minimal CPU-only quick start using the Tinker backend
  • Clarifying GPU vs CPU hardware requirements
  • Making the contribution section more welcoming for new contributors

These changes help lower the entry barrier for first-time users.

P09s and others added 8 commits January 11, 2026 01:43
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Improve documentation for CPU-only users and first-time contributors
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @P09s, 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 significantly improves the project's documentation, making it more accessible and user-friendly for a broader audience. It specifically addresses the needs of CPU-only users by providing a streamlined quick-start guide and clarifies hardware requirements. Additionally, the contribution section has been refined to encourage and guide first-time contributors, lowering the barrier to entry for community involvement.

Highlights

  • CPU-Only Quick Start: Introduced a new "Minimal CPU-Only Quick Start" guide, leveraging the Tinker backend, to facilitate easier onboarding for users without GPU hardware.
  • Hardware Requirements Clarification: Enhanced clarity on hardware requirements, distinguishing between GPU and CPU-only setups and recommending installation methods based on user needs.
  • Improved Contribution Guide: Revised the "Contribution Guide" to be more welcoming and provide clearer entry points for new contributors.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

@P09s
Copy link
Author

P09s commented Jan 11, 2026

Hi maintainers, this PR improves documentation for CPU-only users and first-time contributors.
Please let me know if any changes are needed. Thanks for your time!

Copy link
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 significantly improves the onboarding experience for new users by adding a CPU-only quick start guide, clarifying hardware requirements, and making the contribution section more welcoming. The changes are well-structured and greatly enhance the clarity of the README.md file. My review includes a couple of suggestions to address minor inconsistencies in the installation instructions, which will further improve the documentation's consistency and help prevent potential setup issues for users.

P09s and others added 2 commits January 11, 2026 23:49
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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