Skip to content

docs(plan): update documentation regarding supporting editing of plan files during plan approval#20452

Open
Adib234 wants to merge 6 commits intomainfrom
adibakm/update-docs-edit-plan-file
Open

docs(plan): update documentation regarding supporting editing of plan files during plan approval#20452
Adib234 wants to merge 6 commits intomainfrom
adibakm/update-docs-edit-plan-file

Conversation

@Adib234
Copy link
Contributor

@Adib234 Adib234 commented Feb 26, 2026

Summary

As title suggests

Details

Related Issues

Related to #20348

How to Validate

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

@Adib234 Adib234 self-assigned this Feb 26, 2026
@Adib234 Adib234 requested review from a team as code owners February 26, 2026 16:17
@gemini-cli
Copy link
Contributor

gemini-cli bot commented Feb 26, 2026

Hi @Adib234, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Adib234, 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 enhances the user documentation by providing clearer instructions on how to interact with plan files during the approval workflow. It introduces a new method for manual refinement of plans using an external editor and updates the keyboard shortcut reference to reflect this capability, improving the clarity and usability of the planning process.

Highlights

  • Plan Mode Documentation Update: The documentation for Plan Mode has been updated to explicitly detail the process of manually refining plan files using an external editor during the review and approval stage.
  • Keyboard Shortcut Clarification: The description for the "Ctrl + X" keyboard shortcut has been expanded to clarify its functionality, specifically mentioning its use for opening plan files during Plan Mode approval.
Changelog
  • docs/cli/plan-mode.md
    • Added a new bullet point under "Review & Approval" explaining how to manually refine a plan file using "Ctrl + X" to open it in an external editor.
    • Clarified that the CLI automatically refreshes and shows the updated plan after saving and closing the external editor.
  • docs/reference/keyboard-shortcuts.md
    • Updated the "Action" description for "Ctrl + X" to include "or the plan file during Plan Mode approval" to reflect its expanded documented use.
Activity
  • No activity has been recorded for this pull request 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
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 updates documentation to reflect the ability to edit plan files during the approval process. I've identified a formatting issue in docs/cli/plan-mode.md that breaks the rendering of a list, making it difficult to read. I have provided a suggestion to fix this. The changes in docs/reference/keyboard-shortcuts.md appear correct.

@github-actions
Copy link

github-actions bot commented Feb 26, 2026

Size Change: -2 B (0%)

Total Size: 25.7 MB

ℹ️ View Unchanged
Filename Size Change
./bundle/gemini.js 25.2 MB -2 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 the priority/p1 Important and should be addressed in the near term. label Feb 26, 2026
Co-authored-by: Jerop Kipruto <jerop@google.com>
@Adib234 Adib234 enabled auto-merge February 26, 2026 17:57
@Adib234 Adib234 disabled auto-merge February 26, 2026 18:44
@Adib234 Adib234 enabled auto-merge February 26, 2026 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority/p1 Important and should be addressed in the near term.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants