From e8c014a55536217fed955f4670c743b699d05cda Mon Sep 17 00:00:00 2001 From: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com> Date: Mon, 4 May 2026 00:21:24 +0000 Subject: [PATCH] docs: weekly audit results for 25294954021 --- audit-implementation-log-2026-05-04.md | 30 +++++++++++++++++++ audit-results-2026-05-04.md | 40 ++++++++++++++++++++++++++ docs/cli/cli-reference.md | 21 ++++++++++++++ docs/get-started/index.md | 2 +- docs/get-started/installation.mdx | 16 +++++++---- docs/index.md | 2 ++ docs/reference/commands.md | 14 +++++++++ 7 files changed, 119 insertions(+), 6 deletions(-) create mode 100644 audit-implementation-log-2026-05-04.md create mode 100644 audit-results-2026-05-04.md diff --git a/audit-implementation-log-2026-05-04.md b/audit-implementation-log-2026-05-04.md new file mode 100644 index 0000000000..dfeba2e7cc --- /dev/null +++ b/audit-implementation-log-2026-05-04.md @@ -0,0 +1,30 @@ +# Audit Implementation Log - 2026-05-04 + +## Overview + +Implementation log for the docs audit performed on 2026-05-04. + +## Decisions and Reasoning + +| Finding | Decision | Reasoning | +| :------------------------------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------ | +| `docs/index.md` missing overview for `## Install` | Accept | Adheres to style guide "Every heading must be followed by at least one introductory overview paragraph". | +| `docs/get-started/index.md` "Click on **Sign in**." | Accept | "Click **Sign in**" is more concise and direct. | +| `docs/get-started/installation.mdx` "We recommend" | Accept | Violates "Avoid 'we'". | +| `docs/get-started/installation.mdx` missing "Next steps" | Accept | Adheres to style guide "Conclude with a 'Next steps' section if applicable". | +| `docs/cli/cli-reference.md` missing overviews | Accept | Adheres to style guide. | +| `docs/cli/cli-reference.md` missing "Next steps" | Accept | Adheres to style guide. | +| `/gemma` command missing from reference | Accept | Improves technical accuracy and completeness. | +| Advanced UI Settings missing from reference | Reject | Verified they are already present in `docs/reference/configuration.md` via autogen. | +| Conseca details missing | Modify | Brief explanation already exists in settings reference. I'll keep the task to create a dedicated guide as a future improvement. | + +## Implementation Progress + +- [x] Update `docs/index.md` +- [x] Update `docs/get-started/index.md` +- [x] Update `docs/get-started/installation.mdx` +- [x] Update `docs/cli/cli-reference.md` +- [x] Update `docs/reference/commands.md` +- [x] Update `docs/reference/configuration.md` (Verified up to date) +- [x] Run auto-generation scripts (Attempted, verified up to date) +- [ ] Run `npm run format` diff --git a/audit-results-2026-05-04.md b/audit-results-2026-05-04.md new file mode 100644 index 0000000000..09d831574a --- /dev/null +++ b/audit-results-2026-05-04.md @@ -0,0 +1,40 @@ +# Audit Results - 2026-05-04 + +## Phase 1: Editor Audit + +### Summary + +Initial audit of the Gemini CLI documentation for style guide adherence and +technical accuracy. + +### Findings + +| File Path | Violation / Inaccuracy | Recommendation | +| :---------------------------------- | :----------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------ | +| `docs/index.md` | Violation (Formatting): `## Install` heading is followed immediately by a code block. | Add an introductory sentence before the code block. | +| `docs/get-started/index.md` | Violation (Language): "Click on **Sign in**." | Replace with "Click **Sign in**." for more precise verb usage. | +| `docs/get-started/installation.mdx` | Violation (Voice and Tone): Uses "We recommend". | Replace with "Most users use" or similar passive/neutral phrasing, or use imperative voice. | +| `docs/get-started/installation.mdx` | Violation (Structure): Missing "Next steps" section. | Add "Next steps" section linking to authentication. | +| `docs/cli/cli-reference.md` | Violation (Formatting): `## CLI commands` heading followed by a table without overview. | Add an introductory overview paragraph. | +| `docs/cli/cli-reference.md` | Violation (Formatting): `## CLI Options` heading followed by a table without overview. | Add an introductory overview paragraph. | +| `docs/cli/cli-reference.md` | Violation (Formatting): `## Extensions management` heading followed by a table without overview. | Add an introductory overview paragraph. | +| `docs/cli/cli-reference.md` | Violation (Formatting): `## MCP server management` heading followed by a table without overview. | Add an introductory overview paragraph. | +| `docs/cli/cli-reference.md` | Violation (Formatting): `## Skills management` heading followed by a table without overview. | Add an introductory overview paragraph. | +| `docs/cli/cli-reference.md` | Violation (Structure): Missing "Next steps". | Add "Next steps" section. | +| `docs/cli/cli-reference.md` | Inaccuracy (Code): `/memory reload` example uses "for example, `GEMINI.md`". | Ensure the description is concise. (Wait, this is okay, but I can improve it). | + +## Phase 2: Software Engineer Audit + +### Undocumented Features + +- **`/gemma` command:** The `/gemma` slash command is available in sessions but + not listed in the [Command Reference](../reference/commands.md). +- **Advanced UI Settings:** Settings like `ui.footer.items`, + `ui.footer.showLabels`, `ui.renderProcess`, and `ui.terminalBuffer` are + available in the schema but not documented in the + [Configuration Reference](../reference/configuration.md) (due to + `showInDialog: false` or `ignoreInDocs`). They should be added to the + reference as advanced options. +- **Context-Aware Security (Conseca):** The `security.enableConseca` setting is + mentioned in the settings reference but lacks a detailed explanation or + tutorial on how it works. diff --git a/docs/cli/cli-reference.md b/docs/cli/cli-reference.md index a3d17c0a77..1a35798d87 100644 --- a/docs/cli/cli-reference.md +++ b/docs/cli/cli-reference.md @@ -5,6 +5,9 @@ and parameters. ## CLI commands +The following commands are used to start and manage your Gemini CLI sessions +from your terminal. + | Command | Description | Example | | ---------------------------------- | ---------------------------------- | ------------------------------------------------------------ | | `gemini` | Start interactive REPL | `gemini` | @@ -43,6 +46,9 @@ These commands are available within the interactive REPL. ## CLI Options +Use the following global options to configure the behavior of Gemini CLI from +the command line. + | Option | Alias | Type | Default | Description | | -------------------------------- | ----- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--debug` | `-d` | boolean | `false` | Run in debug mode with verbose logging | @@ -87,6 +93,9 @@ These are convenient shortcuts that map to specific models: ## Extensions management +Manage your Gemini CLI extensions with the following commands. Extensions allow +you to add new tools and capabilities to the CLI. + | Command | Description | Example | | -------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------ | | `gemini extensions install ` | Install extension from Git URL or local path | `gemini extensions install https://github.com/user/my-extension` | @@ -106,6 +115,9 @@ See [Extensions Documentation](../extensions/index.md) for more details. ## MCP server management +Connect Gemini CLI to external data sources and tools using the Model Context +Protocol (MCP). + | Command | Description | Example | | ------------------------------------------------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------- | | `gemini mcp add ` | Add stdio-based MCP server | `gemini mcp add github npx -y @modelcontextprotocol/server-github` | @@ -120,6 +132,9 @@ See [MCP Server Integration](../tools/mcp-server.md) for more details. ## Skills management +Manage your discovered agent skills to give Gemini CLI specialized expertise for +specific tasks. + | Command | Description | Example | | -------------------------------- | ------------------------------------- | ------------------------------------------------- | | `gemini skills list` | List all discovered agent skills | `gemini skills list` | @@ -132,3 +147,9 @@ See [MCP Server Integration](../tools/mcp-server.md) for more details. | `gemini skills disable --all` | Disable all skills | `gemini skills disable --all` | See [Agent Skills Documentation](./skills.md) for more details. + +## Next steps + +- Explore the full [Command reference](../reference/commands.md) for interactive + slash commands. +- Configure your session using [Settings](./settings.md). diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 90cc78d40a..cca7f6cdb9 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -43,7 +43,7 @@ cases, you can log in with your existing Google account: 3. Select your Google account. -4. Click on **Sign in**. +4. Click **Sign in**. Certain account types may require you to configure a Google Cloud project. For more information, including other authentication methods, see diff --git a/docs/get-started/installation.mdx b/docs/get-started/installation.mdx index eaf175e30a..6d83c04d1f 100644 --- a/docs/get-started/installation.mdx +++ b/docs/get-started/installation.mdx @@ -22,8 +22,8 @@ installation methods, and release types. ## Install Gemini CLI -We recommend most users install Gemini CLI using one of the following -installation methods. Note that Gemini CLI comes pre-installed on +Most users install Gemini CLI using one of the following installation methods. +Note that Gemini CLI comes pre-installed on [**Cloud Shell**](https://docs.cloud.google.com/shell/docs) and [**Cloud Workstations**](https://cloud.google.com/workstations). @@ -73,7 +73,7 @@ installation methods. Note that Gemini CLI comes pre-installed on ## Run Gemini CLI -For most users, we recommend running Gemini CLI with the `gemini` command: +Use the `gemini` command to start an interactive session: ```bash gemini @@ -157,8 +157,8 @@ You can also run Gemini CLI using one of the following advanced methods: ## Releases -Gemini CLI has three release channels: stable, preview, and nightly. For most -users, we recommend the stable release, which is the default installation. +Gemini CLI has three release channels: stable, preview, and nightly. Most users +use the stable release, which is the default installation. @@ -199,3 +199,9 @@ users, we recommend the stable release, which is the default installation. + +## Next steps + +- [Authenticate](./authentication.mdx) your Gemini CLI session. +- Learn about [Gemini 3 on Gemini CLI](./gemini-3.md). + diff --git a/docs/index.md b/docs/index.md index d5fefce47c..eaf7bad935 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,6 +6,8 @@ context. ## Install +Install Gemini CLI globally using `npm`: + ```bash npm install -g @google/gemini-cli ``` diff --git a/docs/reference/commands.md b/docs/reference/commands.md index 5bc336dd0c..e438e0fa25 100644 --- a/docs/reference/commands.md +++ b/docs/reference/commands.md @@ -193,6 +193,20 @@ Slash commands provide meta-level control over the CLI itself. - **`update`**: - **Description:** Update extensions. Usage: update |--all +### `/gemma` + +- **Description:** Manage local Gemma models and LiteRT-LM server integration. +- **Sub-commands:** + - **`setup`**: + - **Description:** Guide you through the setup of local Gemma models. + - **`status`**: + - **Description:** Check the status of the LiteRT-LM server and local model + availability. + - **`start`**: + - **Description:** Manually start the local LiteRT-LM server. + - **`stop`**: + - **Description:** Stop the running LiteRT-LM server. + ### `/help` (or `/?`) - **Description:** Display help information about Gemini CLI, including