Docs: Update plan mode docs

[jkcinouye]

Summary

This PR updates our plan mode documentation to conform to our existing style guide.

Details

This PR:

• Revises plan mode documentation to include active language and clear directions.
• Restructures headings to be scannable and clear.
• Removes table of contents and other style artifacts.

Related Issues

Fixes #19679.

How to Validate

This is a docs-only change. Validate that there are no unintended changes or errors.

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

[gemini-code-assist]

Summary of Changes

Hello @jkcinouye, 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 improves the Plan Mode documentation by refining its language, reorganizing its structure, and removing unnecessary elements. The changes aim to make the documentation more accessible and easier to navigate, ensuring users can quickly grasp how to enable, use, and customize Plan Mode within the Gemini CLI.

Highlights

• Documentation Style Guide Conformance: Revised the Plan Mode documentation to align with existing style guidelines, focusing on active language and clear directions.
• Content Restructuring: Restructured headings and sections within the Plan Mode documentation to enhance scannability and clarity for users.
• Removal of Obsolete Elements: Removed the internal table of contents and other outdated stylistic artifacts from the documentation.

Changelog

• docs/cli/plan-mode.md
  • Updated introductory phrasing for Plan Mode to use more active language.
  • Removed the internal table of contents for a cleaner layout.
  • Restructured and renamed several headings (e.g., 'Enabling Plan Mode' to 'How to enable Plan Mode') for improved clarity and flow.
  • Revised instructions for enabling and entering Plan Mode, providing clearer steps and options.
  • Rephrased descriptions for planning workflow steps and tool restrictions.
  • Updated language for tool descriptions, replacing 'e.g.,' with 'for example,' and 'allows' with 'lets you'.
  • Removed the reference to 'YOLO mode'.
• docs/tools/planning.md
  • Updated introductory phrasing for planning tools, changing 'allow' to 'let'.
  • Replaced 'e.g.,' with 'for example,' in tool parameter and output descriptions for consistency.

Activity

• No human activity (comments, reviews, etc.) has been recorded on 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. ↩

[gemini-code-assist]

Code Review

This PR updates the documentation for Plan Mode, improving readability and structure. The changes use active language, reorganize headings, and remove the table of contents, which aligns with the goal of conforming to the style guide. I've retained the original comment regarding the removal of a critical note about the enter_plan_mode tool's incompatibility with YOLO mode from plan-mode.md. This information is still present in the tool's own documentation (planning.md) and is important for users to understand the feature's limitations. The recommendation to re-add this note is crucial to prevent user confusion and maintain consistency across the documentation.

[github-actions]

Size Change: -2 B (0%)

Total Size: 25.9 MB

ℹ️ View Unchanged

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

[g-samroberts]

Just some items that concern me, not necessarily that we need to change it or anything.

Btw we might want to update our docs_writer skill with some of the common edits, like using "lets you" instead of "allows you" and "for example" instead of "e.g.".

[gemini-code-assist]

Code Review

This pull request updates the documentation for Plan Mode to improve clarity, adopt a more active voice, and align with the style guide. The changes are generally positive, making the documentation more scannable and user-friendly. I've identified one area where a valid configuration method was removed, making the documentation incomplete. My specific feedback is in the review comment.

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