docs: Add User Guide section#2647
Conversation
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 undertakes a significant reorganization of the project's documentation by establishing a comprehensive 'User Guide' section. The primary goal is to enhance the user experience by centralizing and structuring content related to core concepts, SDK usage, configuration, deployment, and monitoring. This involved extensive renaming and relocation of existing files, along with the creation of new introductory pages to provide a clearer and more intuitive navigation path for users interacting with the MCP Toolbox. Highlights
Changelog
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. 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
|
Link Resolution NoteLocal links and directory changes work differently on GitHub than on the docsite. You must ensure fixes pass the GitHub check and also work with Summary
Errors per inputErrors in docs/en/user-guide/configuration/pre-post-processing/go.md
Errors in docs/en/user-guide/configuration/pre-post-processing/js.md
Errors in docs/en/user-guide/configuration/pre-post-processing/python.md
Errors in docs/en/user-guide/configuration/sources/_index.md
Errors in docs/en/user-guide/configuration/tools/_index.md
Errors in docs/en/user-guide/connect-to/client-sdks/javascript-sdk/adk/index.md
Errors in docs/en/user-guide/connect-to/client-sdks/javascript-sdk/core/index.md
Errors in docs/en/user-guide/connect-to/client-sdks/python-sdk/core/index.md
Errors in docs/en/user-guide/connect-to/client-sdks/python-sdk/langchain/index.md
Errors in docs/en/user-guide/connect-to/client-sdks/python-sdk/llamaindex/index.md
Errors in docs/en/user-guide/connect-to/mcp-client/_index.md
Errors in docs/en/user-guide/deploy-to/cloud-run/_index.md
Errors in docs/en/user-guide/deploy-to/docker/_index.md
Errors in docs/en/user-guide/deploy-to/kubernetes/_index.md
Errors in docs/en/user-guide/getting-started/_index.md
|
There was a problem hiding this comment.
Code Review
This pull request significantly restructures the documentation by introducing a new user-guide section and consolidating content from various other directories. The changes involve renaming and moving many files, updating links, and reorganizing content for better clarity. My review focuses on ensuring the correctness of code examples and the clarity of the documentation content. I've identified several issues in the new and updated documentation, including invalid Go code snippets, broken links, and typos. Addressing these will improve the quality and usability of the user guide.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
🧨 Preview deployments removed. |
## Description
This PR adds the user-guide section of the docsite
The structure is as follows
* /introduction: Architectural overview and high-level details
* Current introduction page
* /getting-started
* Index Page:
* Usage methodologies for the toolbox, including links to various
clients
* Distinction between custom-developed and prebuilt configurations
* Comparison of build-time versus runtime tool implementation
* /configuration:
* Index page: High level information on how to configure MCP Toolbox to
your liking
* **Definitions:** Tool, Source, Prompts, etc
* **Env Vars**: PORT, DEBUG, GOOGLE\_APPLICATION\_CREDENTIALS.
* /authentication: Split into Authorized invocation, Authentication
parameters & Google sign in \+ Client SDK Usage
* /prebuilt-configs: Guide on using prebuilt configs
* /sources: Guide on configuring a source
* /tools: Guide on configuring a tool \+ Client SDK Usage \+ Invoking
from CLI \+ Client SDK Usage
* /toolsets: Guide on configuring a toolset \+ Client SDK Usage \+
Client SDK Usage \+ Generating skills from toolsets
* /prompts: Guide on configuring prompts \+ Link to guide on using it
with Gemini CLI
* /embedding-models: Guide on configuring models \+ Gemini Embeddings
* /toolbox-ui: Debugging with the MCP Toolbox UI
* /connect-to:
* Index page: Connection Toolbox to multiple environments
* /client-sdks:
* `/py`: Python SDK Readme
* `/toolbox-core`: Core SDK Readme
* `/toolbox-langchain`: Toolbox Langchain SDK Readme
* `/toolbox-llamaindex`: Toolbox LlamaIndex SDK Readme
* `/toolbox-adk`: Toolbox ADK SDK Readme
* `/js`: JS SDK Readme
* `/toolbox-core`: Core SDK Readme
* `/toolbox-adk`: Toolbox ADK SDK Readme
* `/go`: Go SDK Readme
* `/core`: Core SDK Readme
* `/tbgenkit`: Tbgenkit SDK Readme
* `/tbadk`: Tbadk SDK Readme
* /mcp-client
* /gemini-cli: Lists all extensions available
* /ides:
* /alloydb-pg
* /alloydb-pg-admin
* …
* /deploy-to:
* Index page: Various ways to deploy the server
* /docker: Deploy to Docker
* /kubernetes: Deploy to Kubernetes
* /cloud-run: Deploy to Cloud Run
* /monitoring: OpenTelemetry and how to export it
## 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](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a
[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
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>
---------
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This PR adds the user-guide section of the docsite
The structure is as follows
* /introduction: Architectural overview and high-level details
* Current introduction page
* /getting-started
* Index Page:
* Usage methodologies for the toolbox, including links to various
clients
* Distinction between custom-developed and prebuilt configurations
* Comparison of build-time versus runtime tool implementation
* /configuration:
* Index page: High level information on how to configure MCP Toolbox to
your liking
* **Definitions:** Tool, Source, Prompts, etc
* **Env Vars**: PORT, DEBUG, GOOGLE\_APPLICATION\_CREDENTIALS.
* /authentication: Split into Authorized invocation, Authentication
parameters & Google sign in \+ Client SDK Usage
* /prebuilt-configs: Guide on using prebuilt configs
* /sources: Guide on configuring a source
* /tools: Guide on configuring a tool \+ Client SDK Usage \+ Invoking
from CLI \+ Client SDK Usage
* /toolsets: Guide on configuring a toolset \+ Client SDK Usage \+
Client SDK Usage \+ Generating skills from toolsets
* /prompts: Guide on configuring prompts \+ Link to guide on using it
with Gemini CLI
* /embedding-models: Guide on configuring models \+ Gemini Embeddings
* /toolbox-ui: Debugging with the MCP Toolbox UI
* /connect-to:
* Index page: Connection Toolbox to multiple environments
* /client-sdks:
* `/py`: Python SDK Readme
* `/toolbox-core`: Core SDK Readme
* `/toolbox-langchain`: Toolbox Langchain SDK Readme
* `/toolbox-llamaindex`: Toolbox LlamaIndex SDK Readme
* `/toolbox-adk`: Toolbox ADK SDK Readme
* `/js`: JS SDK Readme
* `/toolbox-core`: Core SDK Readme
* `/toolbox-adk`: Toolbox ADK SDK Readme
* `/go`: Go SDK Readme
* `/core`: Core SDK Readme
* `/tbgenkit`: Tbgenkit SDK Readme
* `/tbadk`: Tbadk SDK Readme
* /mcp-client
* /gemini-cli: Lists all extensions available
* /ides:
* /alloydb-pg
* /alloydb-pg-admin
* …
* /deploy-to:
* Index page: Various ways to deploy the server
* /docker: Deploy to Docker
* /kubernetes: Deploy to Kubernetes
* /cloud-run: Deploy to Cloud Run
* /monitoring: OpenTelemetry and how to export it
> 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](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a
[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
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>
---------
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - #2647 - #2648 - #2649 - #2650 - #2652 - #2664 - #2665 - #2666 - #2668 - #2670 - #2723 - #2779 - #2788 - #2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - #2647 - #2648 - #2649 - #2650 - #2652 - #2664 - #2665 - #2666 - #2668 - #2670 - #2723 - #2779 - #2788 - #2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - #2647 - #2648 - #2649 - #2650 - #2652 - #2664 - #2665 - #2666 - #2668 - #2670 - #2723 - #2779 - #2788 - #2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com> 5b25ce0
Description
This PR adds the user-guide section of the docsite
The structure is as follows
/py: Python SDK Readme/toolbox-core: Core SDK Readme/toolbox-langchain: Toolbox Langchain SDK Readme/toolbox-llamaindex: Toolbox LlamaIndex SDK Readme/toolbox-adk: Toolbox ADK SDK Readme/js: JS SDK Readme/toolbox-core: Core SDK Readme/toolbox-adk: Toolbox ADK SDK Readme/go: Go SDK Readme/core: Core SDK Readme/tbgenkit: Tbgenkit SDK Readme/tbadk: Tbadk SDK ReadmePR Checklist
CONTRIBUTING.md
bug/issue
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
!if this involve a breaking change🛠️ Fixes #<issue_number_goes_here>