Skip to content

docs: Fix documentation after internal review#2723

Open
dishaprakash wants to merge 30 commits intodocumentation-reorgfrom
final-changes
Open

docs: Fix documentation after internal review#2723
dishaprakash wants to merge 30 commits intodocumentation-reorgfrom
final-changes

Conversation

@dishaprakash
Copy link
Contributor

@dishaprakash dishaprakash commented Mar 12, 2026

Description

This PR:

  • Splits PR Preview into build and deploy workflows to fix RCE Vulnerability.
  • Moves pre and post processing to Build with MCP toolbox
  • Adds headings to _index.md pages which lists the directories under it.
  • Adds discord link and medium logo
  • Reference the quickstarts from getting-started

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>

@dishaprakash dishaprakash requested a review from a team as a code owner March 12, 2026 13:13
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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

  • Documentation Reorganization: Moved pre and post-processing documentation from the 'user-guide/configuration' path to a new 'build-with-mcp-toolbox' section to improve logical grouping and discoverability.
  • Navigation Enhancements: Added new headings to several _index.md files, such as 'Explore Configuration Modules' and 'Available Connection Methods', to enhance navigation and content discoverability within the documentation.
  • Community Integration: Introduced a new documentation page for the Discord community, providing a direct link and redirect for users to join.
  • Build Configuration Updates: Updated Cloud Build configuration files to reflect the new documentation paths for Go, JavaScript, and Python pre-post processing examples.
Changelog
  • .ci/sample_tests/pre_post_processing/go.integration.cloudbuild.yaml
    • Updated the target root path for Go pre-post processing documentation.
  • .ci/sample_tests/pre_post_processing/js.integration.cloudbuild.yaml
    • Updated the target root path for JavaScript pre-post processing documentation.
  • .ci/sample_tests/pre_post_processing/py.integration.cloudbuild.yaml
    • Updated the target root path for Python pre-post processing documentation.
  • docs/en/blogs/_index.md
    • Added a newspaper icon to the 'Featured Articles' page.
  • docs/en/discord/_index.md
    • Added a new page with a Discord link and redirect.
  • docs/en/integrations/_index.md
    • Adjusted the display weight of the Integrations section.
  • docs/en/reference/_index.md
    • Adjusted the display weight of the Reference section.
  • docs/en/user-guide/_index.md
    • Adjusted the display weight of the User Guide section.
  • docs/en/user-guide/configuration/_index.md
    • Added a new heading 'Explore Configuration Modules'.
  • docs/en/user-guide/configuration/pre-post-processing/_index.md
    • Renamed the index file for pre-post processing documentation.
  • docs/en/user-guide/configuration/pre-post-processing/go.md
    • Renamed the Go-specific pre-post processing guide.
  • docs/en/user-guide/configuration/pre-post-processing/go/adk/agent.go
    • Renamed the Go ADK agent example file.
  • docs/en/user-guide/configuration/pre-post-processing/go/adk/go.mod
    • Renamed the Go module definition file.
  • docs/en/user-guide/configuration/pre-post-processing/go/adk/go.sum
    • Renamed the Go module checksum file.
  • docs/en/user-guide/configuration/pre-post-processing/go/agent_test.go
    • Renamed the Go agent test file.
  • docs/en/user-guide/configuration/pre-post-processing/js.md
    • Renamed the JavaScript-specific pre-post processing guide.
  • docs/en/user-guide/configuration/pre-post-processing/js/adk/agent.js
    • Renamed the JavaScript ADK agent example file.
  • docs/en/user-guide/configuration/pre-post-processing/js/adk/package-lock.json
    • Renamed the JavaScript package lock file.
  • docs/en/user-guide/configuration/pre-post-processing/js/adk/package.json
    • Renamed the JavaScript package definition file.
  • docs/en/user-guide/configuration/pre-post-processing/js/agent.test.js
    • Renamed the JavaScript agent test file.
  • docs/en/user-guide/configuration/pre-post-processing/js/langchain/agent.js
    • Renamed the JavaScript Langchain agent example file.
  • docs/en/user-guide/configuration/pre-post-processing/js/langchain/package-lock.json
    • Renamed the JavaScript Langchain package lock file.
  • docs/en/user-guide/configuration/pre-post-processing/js/langchain/package.json
    • Renamed the JavaScript Langchain package definition file.
  • docs/en/user-guide/configuration/pre-post-processing/python.md
    • Renamed the Python-specific pre-post processing guide.
  • docs/en/user-guide/configuration/pre-post-processing/python/init.py
    • Renamed the Python initialization file.
  • docs/en/user-guide/configuration/pre-post-processing/python/adk/agent.py
    • Renamed the Python ADK agent example file.
  • docs/en/user-guide/configuration/pre-post-processing/python/adk/requirements.txt
    • Renamed the Python ADK requirements file.
  • docs/en/user-guide/configuration/pre-post-processing/python/agent_test.py
    • Renamed the Python agent test file.
  • docs/en/user-guide/configuration/pre-post-processing/python/langchain/agent.py
    • Renamed the Python Langchain agent example file.
  • docs/en/user-guide/configuration/pre-post-processing/python/langchain/requirements.txt
    • Renamed the Python Langchain requirements file.
  • docs/en/user-guide/connect-to/_index.md
    • Added a new heading 'Available Connection Methods'.
  • docs/en/user-guide/connect-to/client-sdks/_index.md
    • Refined the introductory text for client SDKs.
  • docs/en/user-guide/getting-started/_index.md
    • Removed an extraneous blank line and introduced a 'Popular Quickstarts' section with new content.
Ignored Files
  • Ignored by pattern: .github/workflows/** (2)
    • .github/workflows/docs_preview_build_cf.yaml
    • .github/workflows/docs_preview_deploy_cf.yaml
Activity
  • No activity has been recorded for this pull request yet.
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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 12, 2026

Link Resolution Note

Local links and directory changes work differently on GitHub than on the docsite. You must ensure fixes pass the GitHub check and also work with hugo server.
See Link Checking and Fixing with Lychee for more details.

Summary

Status Count
🔍 Total 1037
✅ Successful 782
⏳ Timeouts 0
👻 Excluded 57
❓ Unknown 0
🚫 Errors 6
⛔ Unsupported 0

Errors per input

Errors in DEVELOPER.md

  • [ERROR] https://play.dgraph.io/ | Network error: Connection failed. Check network connectivity and firewall settings (error sending request for url (https://play.dgraph.io/)): Connection failed. Check network connectivity and firewall settings

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

Full Github Actions output

@github-actions
Copy link
Contributor

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

@dishaprakash dishaprakash changed the title docs: Move pre and post processing to Build with mcp toolbox docs: Fix documentation after internal review Mar 12, 2026
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

Base automatically changed from google-analytics to documentation-reorg March 12, 2026 13:56
@github-actions
Copy link
Contributor

@dishaprakash dishaprakash assigned averikitsch and unassigned Yuan325 Mar 14, 2026
@dishaprakash dishaprakash added the priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. label Mar 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants