-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: Fix documentation after internal review #2723
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
474c9f4
docs: Add User Guide section
dishaprakash 855a49b
rebase
dishaprakash 79bf3a4
docs: Add reference and other docs
dishaprakash 193a42d
Update docs/en/reference/faq.md
dishaprakash 81530d5
use sticky comment
dishaprakash 714a400
remove prs from pull_request_target and add second hugo config
dishaprakash 0d88a0a
docs: Add page standardization to external source integrations
dishaprakash 8881afc
add documentation and ci check
dishaprakash 520be56
docs: Add page standardization to external tool integrations
dishaprakash 7aac941
docs: integrate Pagefind search, Google Analytics, and feedback buttons
dishaprakash 43d6662
docs: Move pre and post processing to Build with mcp toolbox
dishaprakash 29a36f5
Update docs_preview_deploy_cf.yaml
dishaprakash bb423c1
gemini review
dishaprakash df3bc5d
update links
dishaprakash 0898cd1
remove header check for pre and post processing samples
dishaprakash 500c3d0
Update cockroachdb-list-schemas.md
dishaprakash cfd74b8
Update DEVELOPER.md
dishaprakash 5d9def4
Update _index.md
dishaprakash 762b735
Update cockroachdb-list-schemas.md
dishaprakash File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,7 @@ on: | |
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/docs**' | ||
| - '.ci/lint-docs-*.sh' | ||
|
|
||
| jobs: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| name: "CF: Build Docs Preview" | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/docs*_cf.yaml' | ||
| - '.hugo/**' | ||
|
|
||
| permissions: read-all | ||
|
|
||
| jobs: | ||
| build-preview: | ||
| runs-on: ubuntu-24.04 | ||
| env: | ||
| PR_NUMBER: ${{ github.event.number }} | ||
| HEAD_SHA: ${{ github.event.pull_request.head.sha }} | ||
| concurrency: | ||
| group: "cf-preview-${{ github.event.number }}" | ||
| cancel-in-progress: true | ||
| defaults: | ||
| run: | ||
| working-directory: .hugo | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ env.HEAD_SHA }} | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Setup Hugo | ||
| uses: peaceiris/actions-hugo@v3 | ||
| with: | ||
| hugo-version: "0.145.0" | ||
| extended: true | ||
|
|
||
| - name: Setup Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: 'npm' | ||
| cache-dependency-path: '.hugo/package-lock.json' | ||
|
|
||
| - run: npm ci --ignore-scripts | ||
| - run: hugo --minify --config hugo.cloudflare.toml | ||
| env: | ||
| HUGO_BASEURL: "/" | ||
| HUGO_ENVIRONMENT: preview | ||
| HUGO_RELATIVEURLS: false | ||
|
|
||
| - name: Build Pagefind Search Index | ||
| run: npx pagefind --site public | ||
|
|
||
| - name: Prepare Artifact Payload | ||
| run: | | ||
| mkdir -p ../artifact-payload | ||
| cp -r public ../artifact-payload/public | ||
| echo ${{ env.PR_NUMBER }} > ../artifact-payload/pr_number.txt | ||
|
|
||
| - name: Upload Artifact | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: cf-preview-data | ||
| path: artifact-payload/ | ||
| retention-days: 1 | ||
|
|
||
| - name: Deployment Link | ||
| run: | | ||
| DEPLOY_URL="https://github.com/${{ github.repository_owner }}/${{ github.event.repository.name }}/actions/workflows/docs_deploy_cf.yaml" | ||
|
|
||
| echo "### Build Complete" >> $GITHUB_STEP_SUMMARY | ||
| echo "The build for PR #${{ env.PR_NUMBER }} succeeded." >> $GITHUB_STEP_SUMMARY | ||
| echo "The Cloudflare deployment workflow is now starting." >> $GITHUB_STEP_SUMMARY | ||
| echo "---" >> $GITHUB_STEP_SUMMARY | ||
| echo "#### [Track Deployment Progress]($DEPLOY_URL)" >> $GITHUB_STEP_SUMMARY |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: "Discord" | ||
| icon: "fab fa-discord" | ||
| weight: 2 | ||
| description: Join the MCP Toolbox community | ||
| manualLink: "https://discord.gg/Dmm69peqjh" | ||
| manualLinkTarget: _blank | ||
| --- | ||
|
|
||
| <html> | ||
| <head> | ||
| <title>Redirecting to Discord</title> | ||
| <link rel="canonical" href="https://discord.gg/Dmm69peqjh"/> | ||
| <meta http-equiv="refresh" content="0;url=https://discord.gg/Dmm69peqjh"/> | ||
| </head> | ||
| <body> | ||
| <p>Connecting to the community... If you are not automatically redirected, please | ||
| <a href="https://discord.gg/Dmm69peqjh">click here to join our Discord</a>. | ||
| </p> | ||
| </body> | ||
| </html> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| title: "Reference" | ||
| type: docs | ||
| weight: 7 | ||
| weight: 6 | ||
| description: > | ||
| This section contains reference documentation. | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.