docs(plan): add documentation for plan mode tools

[jerop]

Adds documentation for enter_plan_mode and exit_plan_mode tools.

Fixes #18214

[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 significantly enhances the documentation for the CLI's Plan Mode by introducing detailed explanations for the enter_plan_mode and exit_plan_mode tools. These additions provide a clearer understanding of how the agent interacts with Plan Mode, covering tool parameters, expected behaviors, and user confirmation processes, thereby improving the overall clarity of the planning workflow for users and developers.

Highlights

• New Tool Documentation: Dedicated documentation was added for the enter_plan_mode and exit_plan_mode tools, detailing their purpose, parameters, behavior, and user confirmation flows.
• Existing Documentation Updates: The plan-mode.md document was updated to clarify how natural language triggers the enter_plan_mode tool and to correctly reference the exit_plan_mode tool.
• Tool Index Integration: A new 'Planning Tools' category was added to the main tools/index.md file, linking to the comprehensive planning tool documentation.

Changelog

• docs/cli/plan-mode.md
  • Clarified the natural language trigger for enter_plan_mode by explicitly mentioning the tool call.
  • Corrected the numbering for exiting Plan Mode and added a linked reference to the exit_plan_mode tool.
  • Appended new reference links for enter_plan_mode and exit_plan_mode at the end of the document.
• docs/tools/index.md
  • Introduced a new 'Planning Tools' category, linking to the newly created planning.md document.
• docs/tools/planning.md
  • Added a new Markdown file providing detailed documentation for the enter_plan_mode and exit_plan_mode tools, including their functionalities, parameters, and interaction flows.

Activity

• No specific activity (comments, reviews, or progress updates) was provided in the context.

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 valuable documentation for the enter_plan_mode and exit_plan_mode tools, which is crucial for the experimental Plan Mode feature. The changes are well-structured and improve clarity. I've added a few suggestions to correct some minor inaccuracies in the new documentation to ensure it perfectly aligns with the tool's implementation.

[github-actions]

Size Change: -2 B (0%)

Total Size: 24.3 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	24.3 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}