Skip to content

docs: migration of JS Sdk docs #2329

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.

Sign up for GitHub

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

Jump to bottom
Draft
rapid-killer-9 wants to merge 1 commit into
base: sdk-docs-migrate
Choose a base branch
from
Draft

docs: migration of JS Sdk docs #2329

rapid-killer-9 wants to merge 1 commit into from

Conversation

@rapid-killer-9
Copy link
Member

@rapid-killer-9 rapid-killer-9 commented Jan 19, 2026

Description

Docs Migration from JS SDK repo to genai-toolbox repo.

This branch is used as a parent branch for JS SDK docs migration

PR Checklist

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:

  • Make sure you reviewed
    CONTRIBUTING.md
  • Make sure to open an issue as a
    bug/issue
    before writing your code! That way we can discuss the change, evaluate
    designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)
  • Make sure to add ! if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Jan 19, 2026

Summary of Changes

Hello @rapid-killer-9, 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 migrating and significantly enhancing the documentation for the JavaScript SDK within the genai-toolbox repository. The changes aim to improve user experience by providing more detailed guidance on package selection, installation, and overall getting started procedures, ensuring that developers can more easily integrate and utilize the SDKs.

Highlights

  • Documentation Title Update: The title of the JavaScript SDK documentation has been updated from 'JS SDK' to 'Javascript' for clarity and consistency.
  • Enhanced SDK Usage Guidance: New sections have been added to guide users on 'Which Package Should I Use?' and 'Getting Started', providing clear instructions for setting up and utilizing the SDKs.
  • Detailed Package Information: A new 'Available Packages' section includes a comprehensive table detailing the toolbox-core and toolbox-adk packages, their use cases, integration, and links to their respective READMEs and npm versions.
  • Source Code Reference: The documentation now explicitly points to the source code repository for the JS SDK using a notice block.

🧠 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.

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. ↩

@rapid-killer-9 rapid-killer-9 mentioned this pull request Jan 19, 2026
Draft
gemini-code-assist[bot]
gemini-code-assist bot reviewed Jan 19, 2026
View reviewed changes
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 migrates the documentation for the JavaScript SDK. The changes introduce a new index page for the JS SDK docs, detailing the available packages and providing getting started instructions. The changes are well-structured. I've provided a few suggestions to improve the documentation's clarity and consistency, such as fixing a markdown table format, completing the installation instructions, and adhering to file formatting conventions.

docs/en/sdks/JS-sdk/_index.md
README for detailed installation and usage instructions:

| Package | Target Use Case | Integration | Path | Details (README) | Npm Version |
| :------ | :---------- | :---------- | :---------------------- | :---------- | :---------
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The markdown table separator for the "Npm Version" column is inconsistent with the others. For better readability and maintenance of the markdown source, it's good to keep them consistent.

Suggested change
| :------ | :---------- | :---------- | :---------------------- | :---------- | :---------
| :------ | :---------- | :---------- | :---------------------- | :---------- | :---------- |

docs/en/sdks/JS-sdk/_index.md

```bash
# For the core, framework-agnostic SDK
npm install @toolbox-sdk/core
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The "Install the Appropriate SDK" section only provides the installation command for @toolbox-sdk/core. Since the document introduces two packages (@toolbox-sdk/core and @toolbox-sdk/adk), it would be more helpful for users to include the installation command for @toolbox-sdk/adk as well.

Suggested change
npm install @toolbox-sdk/core
npm install @toolbox-sdk/core
# For ADK applications
npm install @toolbox-sdk/adk

docs/en/sdks/JS-sdk/_index.md

{{< notice note >}}
Source code for [js-sdk](https://github.com/googleapis/mcp-toolbox-sdk-js)
{{< /notice >}}
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This file does not end with a newline character. It's a common convention to end files with a newline to ensure file-handling tools work correctly and to prevent issues with version control systems that might show a \ No newline at end of file warning. Please add a newline at the end of the file.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 2026

🔎 Preview at https://googleapis.github.io/genai-toolbox/previews/PR-2329/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@rapid-killer-9