docs: improve custom commands spec clarity

[VdustR]

Summary

• Fix {name} variable description: "branch name" not "folder name" (matches WorktreeInfo.name)
• Clarify {path} and {dir} are absolute paths
• Add env validation details to error handling section
• Add env usage example (Ghostty with GHOSTTY_TITLE)

Test plan

• Spec accurately reflects code behavior
• Examples are valid JSON

🤖 Generated with Claude Code

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

[gemini-code-assist]

Summary of Changes

Hello, 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 enhances the clarity and accuracy of the custom commands specification documentation. It refines variable descriptions, explicitly states that certain paths are absolute, and provides more comprehensive details on environment variable validation and usage. These changes aim to make the documentation more precise and helpful for users configuring custom commands.

Highlights

• Variable Description Updates: Updated the description for the {name} variable in worktree commands from 'Worktree folder name' to 'Branch name, or HEAD if detached' for improved accuracy. Also clarified {name} for workspace items to include 'extension'.
• Absolute Path Clarification: Clarified that {path} and {dir} variables represent absolute paths in both worktree and workspace custom commands.
• Environment Variable Validation: Expanded the 'Settings validation' section to include details about env values needing to be strings.
• Environment Variable Usage Example: Added a new example demonstrating how to use environment variables within custom commands, specifically with GHOSTTY_TITLE.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .changeset/custom-commands-spec-clarity.md
  • Added a new changeset file summarizing the documentation improvements.
• docs/spec/custom-commands.md
  • Updated variable descriptions for {name}, {branch}, {ref}, {path}, and {dir} to improve clarity and accuracy.
  • Enhanced the 'Settings validation' section to include checks for env values.
  • Added a new example demonstrating the use of environment variables in custom commands.

Activity

• No human activity 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 pull request improves the clarity of the custom commands specification by refining variable descriptions, adding details on error handling, and including a new example for environment variables. The changes are well-aligned with the goal of improving documentation. I've found one point of inconsistency in variable definitions that could be addressed to further enhance clarity.