1209861858Affects /docs - (Refined Documentation for deployment and added Some Supporting documentation) Added a github action for deployment Fixes #835 Added Support for mkdocs Example - https://dinesht04.github.io/go-sdk/ Requires Configuration of Github pages as follows:- 1. Enable Github Pages 2. Select gh-pages branch for deployment <img width="1237" height="817" alt="gh-pages" src="https://github.com/user-attachments/assets/01f0b012-d5f3-4011-9af9-7269e657ae6a" /> ## Sources # For mkdocs.yaml 1. https://github.com/modelcontextprotocol/python-sdk/blob/main/mkdocs.yml 2. https://github.com/modelcontextprotocol/java-sdk/blob/main/mkdocs.yml 3. MKDocs official documentation # For Github Action 1. https://github.com/modelcontextprotocol/python-sdk/blob/main/.github/workflows/publish-docs-manually.yml 2. https://github.com/modelcontextprotocol/java-sdk/blob/main/.github/workflows/docs.yml 3. https://github.com/james-willett/material-mkdocs-youtube-2024/blob/main/.github/workflows/ci.yml - From Youtube Tutorial
18 lines
920 B
Go
18 lines
920 B
Go
// Copyright 2025 The Go MCP SDK Authors. All rights reserved.
|
|
// Use of this source code is governed by an MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
//go:generate -command weave go run golang.org/x/example/internal/cmd/weave@latest
|
|
//go:generate weave -o ../../docs/README.md ./README.src.md
|
|
//go:generate weave -o ../../docs/protocol.md ./protocol.src.md
|
|
//go:generate weave -o ../../docs/client.md ./client.src.md
|
|
//go:generate weave -o ../../docs/server.md ./server.src.md
|
|
//go:generate weave -o ../../docs/troubleshooting.md ./troubleshooting.src.md
|
|
//go:generate weave -o ../../docs/rough_edges.md ./rough_edges.src.md
|
|
//go:generate weave -o ../../docs/mcpgodebug.md ./mcpgodebug.src.md
|
|
//go:generate weave -o ../../docs/quick_start.md ./quick_start.src.md
|
|
|
|
// The doc package generates the documentation at /doc, via go:generate.
|
|
//
|
|
// Tests in this package are used for examples.
|
|
package docs
|