Skip to content

Docs: Add documentation for notifications (experimental)(macOS)#21163

Merged
jkcinouye merged 2 commits intomainfrom
docs-notifications
Mar 8, 2026
Merged

Docs: Add documentation for notifications (experimental)(macOS)#21163
jkcinouye merged 2 commits intomainfrom
docs-notifications

Conversation

@jkcinouye
Copy link
Copy Markdown
Contributor

Summary

Adds documentation for Notification settings.

Details

Adds a small page for Notifications.

Related Issues

Closes #21162.

How to Validate

This is just a small page to add notifications to our docs. Review for any inaccuracies, spelling errors, or other mistakes.

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

@jkcinouye jkcinouye marked this pull request as ready for review March 4, 2026 21:25
@jkcinouye jkcinouye requested review from a team as code owners March 4, 2026 21:25
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 introduces comprehensive documentation for the experimental notification feature in Gemini CLI. The new content details the feature's purpose, system requirements, configuration methods, and various notification types, enhancing user understanding and discoverability of this functionality. The documentation is integrated into the existing sidebar navigation.

Highlights

  • New Documentation Page: A dedicated documentation page for the Gemini CLI's experimental notification feature has been added, detailing its functionality, requirements, and usage.
  • Notification Feature Details: The new documentation explains that notifications are currently macOS-only, utilize OSC 9 terminal escape sequences, and can be enabled via the /settings command or by modifying settings.json. It also outlines two types of notifications: 'Action required' and 'Session complete'.
  • Sidebar Navigation Update: The docs/sidebar.json file has been updated to include a link to the new 'Notifications' page within the CLI section, marked with an experimental badge.
Changelog
  • docs/cli/notifications.md
    • Added a new documentation page explaining Gemini CLI system notifications.
    • Detailed the requirements (macOS, OSC 9 terminal support), enablement steps (via /settings or settings.json), and types of notifications (action required, session complete).
  • docs/sidebar.json
    • Inserted a new entry for 'Notifications' into the CLI section of the sidebar.
    • Included a '🔬' badge to indicate the experimental nature of the feature and linked to the new docs/cli/notifications.md page.
Activity
  • The pull request was created by jkcinouye to add documentation for the experimental notifications feature.
  • No further review comments or activity have been recorded yet.
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
Copy Markdown
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 introduces documentation for the new experimental notifications feature on macOS. A new page, notifications.md, has been added, detailing the feature's purpose, requirements, and configuration. The documentation sidebar has also been updated to include a link to this new page. The changes are accurate and well-structured, correctly reflecting the feature's implementation as seen in the related source code. No high or critical issues were found in this documentation update.

Note: Security Review has been skipped due to the limited scope of the PR.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 4, 2026

Size Change: -4 B (0%)

Total Size: 26 MB

ℹ️ View Unchanged
Filename Size Change
./bundle/gemini.js 25.5 MB -4 B (0%)
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 221 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 227 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 11.5 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B

compressed-size-action

@gemini-cli gemini-cli bot added area/core Issues related to User Interface, OS Support, Core Functionality area/documentation Gemini CLI documentation tasks and issues 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item. labels Mar 4, 2026
@jkcinouye jkcinouye added this pull request to the merge queue Mar 8, 2026
Merged via the queue into main with commit 97dfbd4 Mar 8, 2026
27 checks passed
@jkcinouye jkcinouye deleted the docs-notifications branch March 8, 2026 06:44
TravisHaa pushed a commit to TravisHaa/gemini-cli that referenced this pull request Mar 8, 2026
kunal-10-cloud pushed a commit to kunal-10-cloud/gemini-cli that referenced this pull request Mar 12, 2026
SUNDRAM07 pushed a commit to SUNDRAM07/gemini-cli that referenced this pull request Mar 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Issues related to User Interface, OS Support, Core Functionality area/documentation Gemini CLI documentation tasks and issues 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Add new documentation for Notifications (Experimental)

2 participants