Skip to content

Comments

Improve documentation for CPU-only users and first-time contributors#1

Merged
P09s merged 7 commits intomainfrom
P09s-patch-1
Jan 11, 2026
Merged

Improve documentation for CPU-only users and first-time contributors#1
P09s merged 7 commits intomainfrom
P09s-patch-1

Conversation

@P09s
Copy link
Owner

@P09s P09s commented Jan 10, 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.

@gemini-code-assist
Copy link

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 onboarding experience for new users and contributors. By providing a clear CPU-only quick start guide and clarifying hardware requirements, it lowers the barrier to entry for those without dedicated GPU resources. Additionally, the contribution section has been made more inviting, encouraging community engagement and making it easier for newcomers to find ways to contribute.

Highlights

  • CPU-Only Quick Start: Introduced a dedicated "Minimal CPU-Only Quick Start" section in the README.md to guide users without GPUs, leveraging the Tinker backend for easier onboarding.
  • Hardware Requirements Clarification: Enhanced clarity on hardware requirements (GPU vs. CPU) and provided installation recommendations for different user types (Docker, Conda/venv, Tinker) within the installation guide.
  • Welcoming Contribution Guide: Improved the "Contribution Guide" to be more welcoming and suggest clear entry points for new contributors, such as documentation improvements and example workflows.
  • Documentation Readability: Refactored README.md for better readability by removing excessive blank lines and standardizing list formatting across various sections.

🧠 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.

Copy link

@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 does a great job of improving the documentation for new users, especially those without GPUs, by adding a CPU-only quick start guide and clarifying hardware requirements. The restructuring of the installation and contribution sections also makes the README more welcoming.

I've identified a few areas where valuable information, such as links to papers and related projects, was removed during the reformatting. Restoring these links would significantly enhance the documentation's usefulness. I've also made some suggestions to retain helpful notes for Docker users and those troubleshooting installations. Overall, these are excellent changes that lower the barrier to entry for the project.

P09s and others added 6 commits January 11, 2026 01:57
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>
@P09s P09s merged commit d712b6b into main Jan 11, 2026
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