docs: Fix documentation after internal review#2723
docs: Fix documentation after internal review#2723dishaprakash wants to merge 30 commits intodocumentation-reorgfrom
Conversation
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>
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 significantly refactors the documentation structure by relocating pre and post-processing guides to a more intuitive 'Build with MCP Toolbox' section. The changes aim to enhance the user experience by improving content organization and discoverability, including the addition of new navigational headings and a direct link to the community Discord server. These updates ensure that users can more easily find relevant information and engage with the MCP Toolbox community. Highlights
Changelog
Ignored Files
Activity
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 DEVELOPER.md
Errors in docs/en/integrations/alloydb-admin/alloydb-create-cluster.md
Errors in docs/en/integrations/alloydb-admin/alloydb-create-instance.md
Errors in docs/en/integrations/alloydb-admin/alloydb-create-user.md
Errors in docs/en/user-guide/connect-to/client-sdks/javascript-sdk/core/index.md
Errors in docs/en/user-guide/connect-to/mcp-client/_index.md
|
There was a problem hiding this comment.
Code Review
This pull request reorganizes the documentation by moving the pre- and post-processing guides and adds links for community engagement. The changes are mostly correct, but I've found a couple of issues. The new Discord link is a direct channel link which won't work for new users, and should be replaced with a server invite link. Also, the icon for the Medium blog link could be more specific to better represent the brand. Finally, the new quickstarts section would be more helpful with direct links. I've left specific comments with suggestions for these points.
Description
This PR:
Build with MCP toolbox_index.mdpages which lists the directories under it.PR 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>