Skip to content

docs(recipes): replace stale --document-id examples with --document#738

Open
0xjackyang wants to merge 1 commit intogoogleworkspace:mainfrom
0xjackyang:docs/replace-document-id-recipes
Open

docs(recipes): replace stale --document-id examples with --document#738
0xjackyang wants to merge 1 commit intogoogleworkspace:mainfrom
0xjackyang:docs/replace-document-id-recipes

Conversation

@0xjackyang
Copy link
Copy Markdown

Bug Description

Recipe docs still instruct users to run gws docs +write --document-id ..., but the live helper and source both expect --document.

Root Cause

The docs +write helper uses .long("document") in crates/google-workspace-cli/src/helpers/docs.rs, but three recipe skills and their mirrored registry entries were left on the stale --document-id spelling.

Fix

  • update all stale docs +write recipe examples from --document-id to --document
  • cover the three affected recipe skills plus their mirrored registry entries
  • add the required patch changeset

How to Verify

  1. Run gws docs +write --help and confirm the usage shows --document <ID>.
  2. Run git grep -n "document-id" and confirm it returns no hits.
  3. Spot-check the updated recipe skills and crates/google-workspace-cli/registry/recipes.toml.

Verification evidence from live CLI help:

Usage: gws +write [OPTIONS] --document <ID> --text <TEXT>

Test Plan

  • Added regression test for this bug
  • Existing tests still pass or are unnecessary for this docs-only fix
  • Manual verification of the fix

Risk Assessment

Low — documentation/recipe example fix only, no CLI behavior changes.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 20, 2026

🦋 Changeset detected

Latest commit: ba55a29

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 addresses a documentation discrepancy where several recipe examples were referencing a stale CLI flag. By updating these examples to use the correct flag, the documentation now accurately reflects the current CLI behavior, ensuring users can successfully execute the provided recipes without encountering errors.

Highlights

  • Documentation Update: Updated all recipe examples for the gws docs +write command to use the correct --document flag instead of the deprecated --document-id.
  • Consistency: Ensured that all recipe skills and their corresponding registry entries are aligned with the current CLI implementation.
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.

Footnotes

  1. Review the Generative AI Prohibited Use Policy, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@google-cla
Copy link
Copy Markdown

google-cla Bot commented Apr 20, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates several recipe examples and documentation files to replace the --document-id flag with the correct --document flag for the gws docs +write command. A changeset is also included to record this patch. I have no feedback to provide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants