Skip to content

chore(docs): Update docs #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

chore(docs): Update docs #153

wants to merge 6 commits into from

Conversation

c-r33d
Copy link
Contributor

@c-r33d c-r33d commented Aug 13, 2025

  • Run helm-docs to update chart docs

@c-r33d c-r33d requested a review from a team as a code owner August 13, 2025 17:08
Copy link
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.

Summary of Changes

Hello @c-r33d, 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 focuses on updating the documentation for the platform Helm chart. The changes were automatically generated by running helm-docs, ensuring that the README.md file accurately reflects the latest chart versions and configuration options. This includes updates to version badges and refinements to the descriptions and default values of certain service configurations.

Highlights

  • Version Updates: The Helm chart version badge was updated from 0.12.0 to 0.14.0, and the application version badge was updated from v0.7.0 to v0.8.1.
  • Documentation Formatting: The @deprecated tag in the description for server.public_hostname was reordered for clarity.
  • Configuration Documentation Refinement: The default value for services.kas.config was adjusted, specifically reordering registered_kas_uri and root_key, and changing the default of registered_kas_uri from an empty string to null. A more concise description for services.kas.config.registered_kas_uri was also added.
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 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.

Copy link
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 the Helm chart documentation, likely by running helm-docs. The changes include updating version badges and reformatting some configuration parameter descriptions. While most changes are improvements, the description for services.kas.config.registered_kas_uri has lost important information, making it less clear for users. I have added a comment with a suggestion to restore the missing details.

@c-r33d c-r33d enabled auto-merge (squash) August 18, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant