Skip to content
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

doc: updates to clarify cloud shell usage, fixes #1581 #1582

Merged
merged 2 commits into from
Dec 26, 2024

Conversation

ghchinoy
Copy link
Contributor

@ghchinoy ghchinoy commented Dec 25, 2024

Description

Further updates to multimodal docs README to clarify Cloud Shell usage

  • proper substitution within frontend/scripts.js (instead of index.html)
  • entry of project ID in UX (not full model path)

Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Follow the CONTRIBUTING Guide.
  • You are listed as the author in your notebook or README file.
    • Your account is listed in CODEOWNERS for the file(s).
  • [ x] Make your Pull Request title in the https://www.conventionalcommits.org/ specification.
  • Ensure the tests and linter pass (Run nox -s format from the repository root to format).
  • Appropriate docs were updated (if necessary)

Fixes #1581 🦕

@ghchinoy ghchinoy requested a review from a team as a code owner December 25, 2024 21:01
Copy link
Contributor

@code-review-assist code-review-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.

Hi team,

I'm currently reviewing this pull request and will post my full review in a few minutes. In the meantime, here's a quick summary to help you and other reviewers get up to speed:

This pull request, authored by ghchinoy, updates the documentation to clarify Cloud Shell usage for the multimodal live API demo app. The goal is to make the setup instructions clearer and easier to follow. Specifically, the changes address:

  • Improved Cloud Shell Instructions: The README has been updated to provide more precise instructions for using Cloud Shell, including:
    • Correctly referencing the location of the script.js file (now frontend/script.js).
    • Clarifying that only the Project ID is needed in the UI, not the full model path.
    • Updating line numbers in the instructions to reflect the changes in script.js.

The changes are limited to the README.md file within the websocket-demo-app directory. The updated instructions simplify the process of setting up the demo app in Cloud Shell by providing more accurate file paths and input requirements.

Here's a table summarizing the changes:

File Change Line Numbers (Approximate)
gemini/multimodal-live-api/websocket-demo-app/README.md Updated Cloud Shell instructions; corrected file paths and input requirements. 129-142, 157-163

I've reviewed the code and the changes are well-documented and easy to understand. The updated instructions should significantly improve the user experience.


And now, a little haiku to lighten the mood:

Cloud Shell's clear path,
Docs now guide with gentle hand,
Code flows smoothly on.

Best,
Gemini

Copy link
Contributor

@code-review-assist code-review-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.

This pull request clarifies the Cloud Shell usage instructions in the README, which is a valuable improvement for users trying to set up the demo app. The changes correctly identify the location of the PROXY_URL and PROJECT_ID variables and guide users to update them appropriately. The simplification of the model ID instruction is also helpful. Here are a few minor suggestions to further enhance the clarity and completeness of the documentation:

@holtskinner holtskinner merged commit ee4ba39 into GoogleCloudPlatform:main Dec 26, 2024
5 checks passed
@ghchinoy ghchinoy deleted the mmdocs-index-removal branch December 26, 2024 23:55
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.

[Bug]: Multimodal Live README has a few nits in Cloud Shell usage
2 participants