Skip to content

[Docs] Fix errors in docs #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Aug 11, 2025
Merged

[Docs] Fix errors in docs #57

merged 13 commits into from
Aug 11, 2025

Conversation

TJ5
Copy link
Collaborator

@TJ5 TJ5 commented Aug 6, 2025

Fixed some outdated/incorrect information in the documentation.

Changes:

  • Update version on installation page
  • Swap old 'image-to-text' for 'image-text-to-text' in various places
  • Bump v0.0.1 to v0.0.2 for the docker container instructions
  • Fixed markdown in various places

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.

Summary of Changes

Hello @TJ5, 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!

I've addressed several inaccuracies and outdated pieces of information within the documentation. The primary goal of these changes is to ensure that users have access to the most current and correct instructions, particularly regarding installation, task definitions, and Docker usage, thereby improving the overall clarity and usability of the documentation.

Highlights

  • Updated Installation Instructions: I've updated the installation instructions to reflect the current genai-bench package version and added a step for setting up the uv virtual environment.
  • Standardized Task Naming: I've standardized the task name image-to-text to image-text-to-text across relevant documentation pages to ensure consistency.
  • Docker Image Version Update: I've bumped the recommended Docker image version for genai-bench in both installation and usage guides.
  • Markdown Formatting Improvements: I've improved markdown formatting by adding consistent spacing and newlines in various sections for better readability.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 or fill out our survey to provide feedback.

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
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 focuses on improving the documentation by fixing outdated information, correcting task names from 'image-to-text' to 'image-text-to-text', updating version numbers, and improving markdown formatting for better readability. The changes are generally good and enhance the quality of the documentation. I have one suggestion regarding a version number in the installation guide that appears to be a downgrade and could be a typo.

@TJ5 TJ5 changed the title Fix errors in docs [Docs] Fix errors in docs Aug 7, 2025
@TJ5 TJ5 marked this pull request as ready for review August 7, 2025 17:43
@CatherineSue
Copy link
Collaborator

@TJ5
Copy link
Collaborator Author

TJ5 commented Aug 7, 2025

I did test the listed docs. Most of them were fine and I corrected the ones which weren't.

@CatherineSue CatherineSue merged commit 0d64d7e into sgl-project:main Aug 11, 2025
7 checks passed
@TJ5 TJ5 deleted the fix-docs branch August 11, 2025 17:03
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.

3 participants