docs: Add Plan Mode documentation

[jerop]

Closes #16871

[gemini-code-assist]

Summary of Changes

Hello @jerop, I'm Gemini Code Assist¹! 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 detailed documentation for the experimental 'Plan Mode' feature in the Gemini CLI. Plan Mode provides a safe, read-only environment for users to research and design complex changes without the risk of accidental modifications. The new documentation guides users through enabling, configuring, and interacting with this mode, ensuring they can effectively leverage its capabilities for strategic planning.

Highlights

• New Documentation for Plan Mode: A comprehensive documentation page for 'Plan Mode' has been added, detailing its purpose, how to enable and use it, and its tool restrictions.
• CLI Documentation Integration: The main CLI documentation index (docs/cli/index.md) now includes a link to the new 'Plan Mode' documentation under 'Advanced features'.
• Sidebar Navigation Update: The sidebar navigation (docs/sidebar.json) has been updated to include 'Plan Mode', making it easily discoverable within the documentation.

Changelog

• docs/cli/index.md
  • Added a new entry for 'Plan mode' under the 'Advanced features' section, linking to the newly created documentation page.
• docs/cli/plan-mode.md
  • New file added, providing extensive documentation for 'Plan Mode'.
  • Includes sections on how to enable Plan Mode via settings or settings.json.
  • Details various ways to start in Plan Mode, including CLI flags and keyboard shortcuts.
  • Explains the 'Planning Workflow' from requirements clarification to plan review.
  • Outlines methods for exiting Plan Mode.
  • Specifies tool restrictions within Plan Mode, emphasizing its read-only nature for most operations.
  • Provides channels for user feedback on this experimental feature.
• docs/sidebar.json
  • Added a new navigation item for 'Plan mode' with a link to docs/cli/plan-mode.

Activity

• The pull request was created by jerop.
• It addresses and closes issues Add documentation for planning features #16871 and Add docs for EnterPlanMode and ExitPlanMode tools #18214, indicating that this documentation fulfills existing requirements or resolves related concerns.

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. ↩

[gemini-code-assist]

Code Review

This pull request adds comprehensive documentation for the new experimental Plan Mode feature. The documentation is well-structured and covers enabling the feature, usage, and restrictions. The identified areas for clarification in the new documentation page remain relevant to avoid user confusion regarding the feature's workflow and file paths, improving the accuracy of the descriptions for a better user experience.

[github-actions]

Size Change: -2 B (0%)

Total Size: 23.9 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	23.8 MB	-2 B (0%)
./bundle/sandbox-macos-permissive-closed.sb	1.03 kB	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-closed.sb	3.29 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

_{compressed-size-action}