docs(cli): point plan-mode session retention to actual /settings labels#25978
Conversation
The Cleanup section of plan-mode.md instructed users to "search for
Session Retention" in /settings, but that label no longer appears in the
dialog. The schema marks general.sessionRetention as showInDialog: false,
so only its leaves are rendered ("Enable Session Cleanup" and "Keep chat
history"). Update the parenthetical to point at the labels users will
actually find.
Refs google-gemini#14623
Summary of ChangesHello, 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 the CLI guide referenced a non-existent setting label. By updating the instructions to match the actual UI labels, the change ensures that users can correctly locate and configure session retention settings within the application. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in docs/cli/plan-mode.md to reflect changes in the /settings command search terms for session retention, specifically replacing 'Session Retention' with 'Enable Session Cleanup' or 'Keep chat history'. I have no feedback to provide.
Note: Security Review has been skipped due to the limited scope of the PR.
9e7c924
…ls (google-gemini#25978) Co-authored-by: Spencer <spencertang@google.com>
…ls (google-gemini#25978) Co-authored-by: Spencer <spencertang@google.com>
Summary
docs/cli/plan-mode.mdtold users to "customize this behavior via the/settingscommand (search for Session Retention)", but that label no longer exists in the/settingsdialog. The schema marksgeneral.sessionRetentionasshowInDialog: false(a parent grouping), so the dialog only renders the leaves: Enable Session Cleanup (general.sessionRetention.enabled) and Keep chat history (general.sessionRetention.maxAge). A user following the doc would search the dialog and find nothing.Details
Updated the parenthetical to reference the labels that actually appear in the dialog (matching the autogenerated table in
docs/cli/settings.mdlines 40-41). Wording, the surrounding link tosession-management.md#session-retention, and the rest of the Cleanup section are unchanged.This is a follow-up cleanup for the same root cause as #14623; the primary symptom (a missing parent row in the settings reference table) was already addressed when
docs/cli/settings.mdbecame autogenerated, but this stale instruction inplan-mode.mdwas missed.Related Issues
Fixes #14623
How to Validate
npm start/settingsand look at the General category.showInDialog: falseparent — seepackages/cli/src/config/settingsSchema.ts:373-421).docs/cli/plan-mode.md§ Cleanup and confirm the configuration bullet now points at labels you can actually find in step 3.Pre-Merge Checklist