Docs
Summary
This PR fixes incomplete or inconsistent names for matcher for hook documentation.
Details
Related Issues
Fixes #15081 Closes #15081 Resolves #15081
How to Validate
- Open the updated documentation files (docs/hooks/index.md)
- Verify that all previously incomplete or inconsistent names for matcher hooks are corrected
- Check that formatting, spelling, and code examples are consistent
- Optional: build or render docs locally (if applicable) to confirm readability
Pre-Merge Checklist
- [ ] Updated relevant documentation and README (if needed)
- [ ] Added/updated tests (if needed)
- [ ] Noted breaking changes (if any)
- [ ] Validated on required platforms/methods:
- [ ] MacOS
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] Podman
- [ ] Seatbelt
- [ ] Windows
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] Linux
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] MacOS
Summary of Changes
Hello @Roaimkhan, I'm Gemini Code Assist[^1]! 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 enhances the documentation for hook matchers by addressing inconsistencies and expanding coverage within the docs/hooks/index.md file. The changes aim to provide a more accurate and comprehensive reference for developers by correcting existing tool name mappings and introducing detailed information on Gemini CLI-specific and event-based matchers.
Highlights
- Documentation Correction: Corrected incomplete and inconsistent naming conventions for existing matcher hooks within the Gemini CLI tool name mapping table.
- Expanded Tool Name Mappings: Added new tool matchers such as
Glob,Grep, andLSto theClaude CodetoGemini CLImapping table. - New Gemini CLI-Specific Matchers: Introduced comprehensive documentation for matchers exclusive to the Gemini CLI, covering additional tool matchers and various event-based matchers.
- Detailed Event Matchers: Provided specific documentation for
SessionStart,SessionEnd,PreCompress, andNotificationevent matchers, detailing their available types.
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 :thumbsup: and :thumbsdown: 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.
[^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.
@abhipatel12 More than happy to help with these updates.
Great, thank you! Please just @ me again once you are ready for a re-review!
@abhipatel12 I noticed "WriteBinary" is mentioned in the docs, but it doesn’t seem to exist in the code. I’ve converted it to snake_case for consistency, but I can remove it if needed.
Thank you so much for the quick response.
This looks fine as is! I have a separate PR that fixes the bad tool name so ill go ahead and merge this PR as-is since it addresses the main concern from the issue.
Thanks again for the contribution.