From 1f9da6723f7da87afdaf535baf9a3c591ffe4c2d Mon Sep 17 00:00:00 2001 From: Sam Roberts <158088236+g-samroberts@users.noreply.github.com> Date: Tue, 24 Feb 2026 15:44:13 -0800 Subject: [PATCH] Docs: Add nested sub-folders for related topics (#20235) --- docs/index.md | 49 ++++++++++++++++---------------- docs/sidebar.json | 71 +++++++++++++++++++++-------------------------- 2 files changed, 56 insertions(+), 64 deletions(-) diff --git a/docs/index.md b/docs/index.md index 81e760fadd..3ccaf3b797 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,8 +21,10 @@ Jump in to Gemini CLI. personal and enterprise accounts. - **[Examples](./get-started/examples.md):** Practical examples of Gemini CLI in action. -- **[Cheatsheet](./cli/cli-reference.md):** A quick reference for common +- **[CLI cheatsheet](./cli/cli-reference.md):** A quick reference for common commands and options. +- **[Gemini 3 on Gemini CLI](./get-started/gemini-3.md):** Learn about Gemini 3 + support in Gemini CLI. ## Use Gemini CLI @@ -50,33 +52,29 @@ User-focused guides and tutorials for daily development workflows. Technical documentation for each capability of Gemini CLI. -- **[Activate skill (tool)](./tools/activate-skill.md):** Internal mechanism for - loading expert procedures. -- **[Ask user (tool)](./tools/ask-user.md):** Internal dialog system for - clarification. -- **[Checkpointing](./cli/checkpointing.md):** Automatic session snapshots. -- **[File system (tool)](./tools/file-system.md):** Technical details for local - file operations. -- **[Headless mode](./cli/headless.md):** Programmatic and scripting interface. -- **[Internal documentation (tool)](./tools/internal-docs.md):** Technical - lookup for CLI features. -- **[Memory (tool)](./tools/memory.md):** Storage details for persistent facts. -- **[Model routing](./cli/model-routing.md):** Automatic fallback resilience. -- **[Plan mode 🧪](./cli/plan-mode.md):** Use a safe, read-only mode for - planning complex changes. -- **[Subagents 🧪](./core/subagents.md):** Using specialized agents for specific +- **[Extensions](./extensions/index.md):** Extend Gemini CLI with new tools and + capabilities. +- **[Agent Skills](./cli/skills.md):** Use specialized agents for specific tasks. -- **[Remote subagents 🧪](./core/remote-agents.md):** Connecting to and using +- **[Checkpointing](./cli/checkpointing.md):** Automatic session snapshots. +- **[Headless mode](./cli/headless.md):** Programmatic and scripting interface. +- **[Hooks](./hooks/index.md):** Customize Gemini CLI behavior with scripts. +- **[IDE integration](./ide-integration/index.md):** Integrate Gemini CLI with + your favorite IDE. +- **[MCP servers](./tools/mcp-server.md):** Connect to and use remote agents. +- **[Model routing](./cli/model-routing.md):** Automatic fallback resilience. +- **[Model selection](./cli/model.md):** Choose the best model for your needs. +- **[Plan mode 🔬](./cli/plan-mode.md):** Use a safe, read-only mode for + planning complex changes. +- **[Subagents 🔬](./core/subagents.md):** Using specialized agents for specific + tasks. +- **[Remote subagents 🔬](./core/remote-agents.md):** Connecting to and using remote agents. +- **[Rewind](./cli/rewind.md):** Rewind and replay sessions. - **[Sandboxing](./cli/sandbox.md):** Isolate tool execution. -- **[Shell (tool)](./tools/shell.md):** Detailed system execution parameters. +- **[Settings](./cli/settings.md):** Full configuration reference. - **[Telemetry](./cli/telemetry.md):** Usage and performance metric details. -- **[Todo (tool)](./tools/todos.md):** Progress tracking specification. - **[Token caching](./cli/token-caching.md):** Performance optimization. -- **[Web fetch (tool)](./tools/web-fetch.md):** URL retrieval and extraction - details. -- **[Web search (tool)](./tools/web-search.md):** Google Search integration - technicals. ## Configuration @@ -91,7 +89,6 @@ Settings and customization options for Gemini CLI. parameters like temperature and thinking budget. - **[Project context (GEMINI.md)](./cli/gemini-md.md):** Technical hierarchy of context files. -- **[Settings](./cli/settings.md):** Full configuration reference. - **[System prompt override](./cli/system-prompt.md):** Instruction replacement logic. - **[Themes](./cli/themes.md):** UI personalization technical guide. @@ -119,11 +116,13 @@ Deep technical documentation and API specifications. Support, release history, and legal information. - **[FAQ](./resources/faq.md):** Answers to frequently asked questions. -- **[Changelogs](./changelogs/index.md):** Highlights and notable changes. - **[Quota and pricing](./resources/quota-and-pricing.md):** Limits and billing details. - **[Terms and privacy](./resources/tos-privacy.md):** Official notices and terms. +- **[Troubleshooting](./resources/troubleshooting.md):** Common issues and + solutions. +- **[Uninstall](./resources/uninstall.md):** How to uninstall Gemini CLI. ## Development diff --git a/docs/sidebar.json b/docs/sidebar.json index 8a4bd7391c..c2c6295bfa 100644 --- a/docs/sidebar.json +++ b/docs/sidebar.json @@ -61,31 +61,53 @@ { "label": "Features", "items": [ - { "label": "Agent Skills", "slug": "docs/cli/skills" }, - { - "label": "Authentication", - "slug": "docs/get-started/authentication" - }, - { "label": "Checkpointing", "slug": "docs/cli/checkpointing" }, { "label": "Extensions", - "slug": "docs/extensions/index" + "collapsed": true, + "items": [ + { + "label": "Overview", + "slug": "docs/extensions" + }, + { + "label": "User guide: Install and manage", + "link": "/docs/extensions/#manage-extensions" + }, + { + "label": "Developer guide: Build extensions", + "slug": "docs/extensions/writing-extensions" + }, + { + "label": "Developer guide: Best practices", + "slug": "docs/extensions/best-practices" + }, + { + "label": "Developer guide: Releasing", + "slug": "docs/extensions/releasing" + }, + { + "label": "Developer guide: Reference", + "slug": "docs/extensions/reference" + } + ] }, + { "label": "Agent Skills", "slug": "docs/cli/skills" }, + { "label": "Checkpointing", "slug": "docs/cli/checkpointing" }, { "label": "Headless mode", "slug": "docs/cli/headless" }, { "label": "Hooks", "slug": "docs/hooks" }, { "label": "IDE integration", "slug": "docs/ide-integration" }, { "label": "MCP servers", "slug": "docs/tools/mcp-server" }, { "label": "Model routing", "slug": "docs/cli/model-routing" }, { "label": "Model selection", "slug": "docs/cli/model" }, - { "label": "Plan mode", "badge": "🧪", "slug": "docs/cli/plan-mode" }, + { "label": "Plan mode", "badge": "🔬", "slug": "docs/cli/plan-mode" }, { "label": "Subagents", - "badge": "🧪", + "badge": "🔬", "slug": "docs/core/subagents" }, { "label": "Remote subagents", - "badge": "🧪", + "badge": "🔬", "slug": "docs/core/remote-agents" }, { "label": "Rewind", "slug": "docs/cli/rewind" }, @@ -124,35 +146,6 @@ { "label": "Trusted folders", "slug": "docs/cli/trusted-folders" } ] }, - { - "label": "Extensions", - "items": [ - { - "label": "Overview", - "slug": "docs/extensions" - }, - { - "label": "User guide: Install and manage", - "link": "/docs/extensions/#manage-extensions" - }, - { - "label": "Developer guide: Build extensions", - "slug": "docs/extensions/writing-extensions" - }, - { - "label": "Developer guide: Best practices", - "slug": "docs/extensions/best-practices" - }, - { - "label": "Developer guide: Releasing", - "slug": "docs/extensions/releasing" - }, - { - "label": "Developer guide: Reference", - "slug": "docs/extensions/reference" - } - ] - }, { "label": "Development", "items": [