ac2f175214Add a framework for feature documentation, and start populating it with our SDK documentation. This framework is as follows: - internal/docs/**.src.md is the markdown source for the docs/ directory. - The x/example/internal/cmd/weave tool is used to compile these docs to the top-level docs, supporting both linked code samples and generated tables of contents. - The readme-check workflow is updated to check these docs as well. - The structure of these docs follows the MCP spec. - Wherever possible, example code is linked from actual Go documentation examples, so that it is testable. Some minor modifications to the weave tool were made to support this framework. Additionally, partially fill out this documentation with content on base protocol and client features, as well as troubleshooting help. Along the way, a bug was encountered that our LoggingTransport was not concurrency safe. This is fixed with a mutex. Fixes https://github.com/modelcontextprotocol/go-sdk/issues/466 Fixes https://github.com/modelcontextprotocol/go-sdk/issues/409 Updates https://github.com/modelcontextprotocol/go-sdk/issues/442
39 lines
1 KiB
YAML
39 lines
1 KiB
YAML
name: README Check
|
|
on:
|
|
workflow_dispatch:
|
|
pull_request:
|
|
paths:
|
|
- 'internal/readme/**'
|
|
- 'README.md'
|
|
- 'internal/docs/**'
|
|
- 'docs/**'
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
readme-check:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Set up Go
|
|
uses: actions/setup-go@v5
|
|
- name: Check out code
|
|
uses: actions/checkout@v4
|
|
- name: Check docs is up-to-date
|
|
run: |
|
|
go generate ./...
|
|
if [ -n "$(git status --porcelain)" ]; then
|
|
echo "ERROR: docs are not up-to-date!"
|
|
echo ""
|
|
echo "The docs differ from what would be generated by `go generate ./...`."
|
|
echo "Please update internal/**/*.src.md instead of directly editing README.md or docs/ files,"
|
|
echo "then run `go generate ./...` to regenerate docs."
|
|
echo ""
|
|
echo "Changes:"
|
|
git status --porcelain
|
|
echo ""
|
|
echo "Diff:"
|
|
git diff
|
|
exit 1
|
|
fi
|
|
echo "Docs are up-to-date."
|