docs(core): DSPX-611 - replace reference to public_client_id

[alkalescent]

No description provided.

[gemini-code-assist]

Hello @alkalescent, 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!

Summary of Changes

Hello! Gemini here, providing a summary of this pull request. This PR focuses on updating the documentation for the login command within the core documentation. Specifically, it refines the description for the --client-id flag to remove a reference to a specific default value (public_client_id) and instead provides a generic example (cli-client). This change aims to make the documentation clearer and potentially less tied to a specific internal detail.

Highlights

• Documentation Update: The primary change is an update to the documentation file docs/man/auth/login.md.
• Client ID Description Clarification: The description for the --client-id flag in the login command documentation has been updated to replace a specific default value reference with a generic example.

Changelog

• docs/man/auth/login.md
  • Updated the description for the client-id flag in the login command documentation.
  • Replaced the reference to platform well-known public_client_id with e.g. cli-client.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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

Thank you for this documentation update. The PR aims to replace a reference to public_client_id in the login command's help text, which seems like a good step towards clearer documentation, especially by removing the potentially misleading (default = ...) part for a required flag.

I have one point of feedback regarding the new example provided, focusing on ensuring maximum clarity for the user.

Summary of Findings

• Clarity of client-id example: The new example (e.g. cli-client) for the client-id flag is an improvement over the previous misleading 'default' text. However, it's worth ensuring that this example is either a common/recommended ID or, if it's a generic placeholder, that users have sufficient guidance to find the correct client ID for their specific environment. A comment was added to discuss potential enhancements for user clarity.

Merge Readiness

The pull request makes a positive change by correcting a misleading part of the documentation. However, there's a medium-severity concern regarding the clarity of the new example for the client-id flag. I recommend discussing the feedback provided to ensure the documentation is as helpful as possible for users before merging. As a reviewer, I am not authorized to approve pull requests, so please ensure further review and approval from authorized maintainers after addressing any feedback.

resolved