Docs: Refresh docs to organize and standardize reference materials.

[jkcinouye]

Summary

Refactors documentation between reference and user guides.

Details

Related Issues

Closes #18964

How to Validate

Check for unintended changes, inaccuracies in code, and broken links.

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 focuses on refreshing and reorganizing the Gemini CLI documentation to improve user experience and provide more detailed technical references. The changes include restructuring guides, adding new tutorials, and updating command references to reflect current CLI capabilities.

Highlights

• Documentation Restructuring: The documentation has been reorganized to improve clarity and standardization, focusing on user guides, feature references, and configuration details.
• Headless Mode Enhancement: The documentation for headless mode has been significantly revised to provide a more technical reference, including details on output formats and exit codes.
• Tutorial Additions: New tutorials have been added to guide users on automating tasks, managing files, setting up MCP servers, and more.
• CLI Command Updates: The CLI command reference has been updated, including the removal of the deprecated --prompt flag and enhancements to the /rewind command.

Changelog

• docs/cli/authentication.md
  • Removed deprecated authentication documentation.
• docs/cli/checkpointing.md
  • Minor text adjustments for clarity.
• docs/cli/cli-reference.md
  • Updated command examples and removed deprecated --prompt flag.
  • Added a next steps section.
• docs/cli/commands.md
  • Updated /about command description.
  • Enhanced /rewind command documentation with usage and feature details.
• docs/cli/gemini-md.md
  • Revised context file descriptions and added a next steps section.
• docs/cli/headless.md
  • Complete rewrite to provide a technical reference for headless mode, including output formats and exit codes.
• docs/cli/index.md
  • Restructured the index page to focus on user guides, features, and configuration.
• docs/cli/rewind.md
  • Minor text adjustments for clarity.
• docs/cli/session-management.md
  • Minor text adjustments for clarity.
  • Added a next steps section.
• docs/cli/themes.md
  • Minor text adjustments for clarity.
• docs/cli/tutorials.md
  • Removed the tutorials page.
• docs/cli/tutorials/automation.md
  • Added a new tutorial on automating tasks with headless mode.
• docs/cli/tutorials/file-management.md
  • Added a new tutorial on file management with Gemini CLI.
• docs/cli/tutorials/mcp-setup.md
  • Added a new tutorial on setting up an MCP server.
• docs/cli/tutorials/memory-management.md
  • Added a new tutorial on memory management.
• docs/cli/tutorials/session-management.md
  • Added a new tutorial on session management.
• docs/cli/tutorials/shell-commands.md
  • Added a new tutorial on shell commands.
• docs/cli/tutorials/skills-getting-started.md
  • Minor text adjustments for clarity.
• docs/cli/tutorials/task-planning.md
  • Added a new tutorial on task planning.
• docs/cli/tutorials/web-tools.md
  • Added a new tutorial on web tools.
• docs/core/concepts.md
  • Added a new core concepts page.
• docs/get-started/configuration.md
  • Deprecated the --prompt flag.
• docs/get-started/examples.md
  • Minor text adjustments for clarity.
• docs/get-started/index.md
  • Minor text adjustments for clarity.
• docs/index.md
  • Restructured the index page to focus on getting started, user guides, features, configuration, and reference.
• docs/sidebar.json
  • Updated the sidebar to reflect the new documentation structure.
• docs/tools/activate-skill.md
  • Added a new activate skill tool page.
• docs/tools/ask-user.md
  • Added a new ask user tool page.
• docs/tools/file-system.md
  • Rewrote the file system tools page.
• docs/tools/index.md
  • Rewrote the tools index page.
• docs/tools/internal-docs.md
  • Added a new internal docs tool page.
• docs/tools/memory.md
  • Rewrote the memory tool page.
• docs/tools/shell.md
  • Rewrote the shell tool page.

Activity

• The documentation structure has been significantly reorganized.
• New tutorials have been added to enhance user guidance.
• Several documentation pages have been rewritten for clarity and technical accuracy.
• Deprecated features have been removed from the documentation.

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 is an extensive and well-executed refactoring of the documentation. It significantly improves the organization and navigability by restructuring the content into clear sections like user guides, feature references, and a new core concepts glossary. Many new, focused tutorial pages have been added, and existing content has been standardized into a more concise reference format. The changes are consistent across all modified files, including the sidebar configuration, which now accurately reflects the new information architecture. I have not identified any issues of high or critical severity. The overall quality of the documentation is greatly improved by this work.

[g-samroberts]

Lot of changes that maybe we should break out into smaller PRs, as some should go in asap (like adding more guides, removing tutorials.md and the empty auth page) and some I'm not sure should go in at all. For example, the pages that document "tools" (which I don't think is clearly defined) that users are unable to call, and only are used by the agent. sidebar.json also seems to use "(tool)" to define some page titles but it's not clear what this signifies.

[github-actions]

Size Change: -2 B (0%)

Total Size: 24.4 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	24.4 MB	-2 B (0%)
./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]

Hi there! Thank you for your contribution to Gemini CLI.

To improve our contribution process and better track changes, we now require all pull requests to be associated with an existing issue, as announced in our recent discussion and as detailed in our CONTRIBUTING.md.

This pull request is being closed because it is not currently linked to an issue. Once you have updated the description of this PR to link an issue (e.g., by adding Fixes #123 or Related to #123), it will be automatically reopened.

How to link an issue:
Add a keyword followed by the issue number (e.g., Fixes #123) in the description of your pull request. For more details on supported keywords and how linking works, please refer to the GitHub Documentation on linking pull requests to issues.

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