docs: migration of core package samples from go sdk#2330
docs: migration of core package samples from go sdk#2330AnmolShukla2002 merged 8 commits intomigrate-go-sdkfrom
Conversation
Summary of ChangesHello @AnmolShukla2002, 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 significantly enhances the documentation for the MCP Toolbox Go SDK's core package. It provides developers with a centralized and comprehensive resource for understanding the SDK's capabilities, from basic setup and tool interaction to advanced topics like secure authentication mechanisms and flexible parameter binding. Furthermore, it offers ready-to-use integration samples for leading AI orchestration frameworks, streamlining the development of intelligent applications using the Toolbox. Highlights
🧠 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 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
|
There was a problem hiding this comment.
Code Review
This pull request adds extensive documentation and samples for the Go SDK core package. The documentation is comprehensive, but I've found several issues in the code samples, including incomplete examples, incorrect API usage, unhandled errors, and typos. These issues could confuse users or cause their code to fail if they copy the examples. I've left specific comments with suggestions for fixes. Addressing these will greatly improve the quality and usability of the documentation.
|
There seem to be links to the READMEs of individual packages in the top-level doc (screenshot). Can we have them linked to this docsite? |
I guess docs reorganization strategy states that we will "treat each SDK repository as the source of truth for its own API reference". While the docsite serves as the "one-stop-shop" for conceptual guides, the github links serve as the technical reference point until our auto-generated API subdomains are fully live. I am not sure on this, let me know your thoughts? |
Sounds good! Let’s link directly to the github source files until we have the API ref docsite up. However for links like those under “Which package should I use?”, I guess I was assuming the links from |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
yes made these changes! |
Bot's comments are mostly regarding the sample...I am not sure If I should make these changes as it would then defer from the sample in the Sdk repos? |
Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com>
Can we apply any grammatical or any other minor suggestions from the bot, without affecting the functionality? |
Okay sure! |
|
🧨 Preview deployments removed. |
This PR migrates the Go SDK documentation and core technical samples from the [mcp-toolbox-sdk-go] repository to the main genai-toolbox documentation site. This consolidation ensures that conceptual guides, package overviews, and interactive code examples are available in a centralized "one-stop-shop".