Skip to content

Conversation

@geoffreyweal
Copy link
Contributor

Previewing GUFI added to Modules section of Support Page.

  • May not be the best place for it at the moment, but available for users to preview

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @geoffreyweal, 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 integrates comprehensive documentation for the Grand Unified File Index (GUFI) tool into the project's support pages, specifically within the "Modules" section. This addition aims to provide users with detailed guidance on utilizing GUFI for efficient file system metadata indexing, including its gufi_find and gufi_du commands. Concurrently, the README.md has been enhanced with instructions for local documentation preview, streamlining the development and review process for future documentation updates.

Highlights

  • GUFI Documentation Added: New documentation for the Grand Unified File Index (GUFI) tool has been introduced, detailing its purpose, commands (gufi_find, gufi_du), and important usage considerations.
  • Local Documentation Preview Instructions: The README.md file has been updated to include instructions on how to run the documentation site locally using mkdocs serve -c.
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.


Files indexed deep, GUFI finds what's hidden, fast, Docs light the true path.

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.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 30, 2025

@CallumWalley
Copy link
Member

For pages to link to module index, they need to have the same name. So lower case. Also wont be picked up if it is a hidden module.

@CallumWalley CallumWalley marked this pull request as draft November 19, 2025 22:00
@jen-reeve jen-reeve marked this pull request as ready for review November 30, 2025 22:37
Copy link
Contributor

@jen-reeve jen-reeve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jen-reeve jen-reeve enabled auto-merge (squash) November 30, 2025 22:38
@jen-reeve jen-reeve merged commit 4cd6e44 into main Nov 30, 2025
8 checks passed
@jen-reeve jen-reeve deleted the add-gufi-to-modules branch November 30, 2025 22:38
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.

4 participants