Skip to content

Conversation

@jonathanhefner
Copy link
Member

Context: I am working on getting documentation up for each MCP SDK at https://modelcontextprotocol.github.io/*-sdk/. I realize the Go ecosystem has its own idioms for generating and hosting documentation, so I am proposing we make https://modelcontextprotocol.github.io/go-sdk/ redirect to the latest tag of https://github.com/modelcontextprotocol/go-sdk/blob/v1.1.0/docs/README.md.


Adds a redirect page at https://modelcontextprotocol.github.io/go-sdk/ that automatically redirects visitors to the docs/README.md of the latest release tag. Uses Jekyll templating with site.github.latest_release to dynamically resolve the current release version at build time.

🤖 Generated with Claude Code

Adds a redirect page at modelcontextprotocol.github.io/go-sdk/ that
automatically redirects visitors to the docs/README.md of the latest
release tag. Uses Jekyll templating with site.github.latest_release
to dynamically resolve the current release version at build time.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@findleyr
Copy link
Contributor

Thanks! Will we be the only SDK with this solution? I think we'd actually wanted to contribute official docs, but are slim on bandwidth at the moment.

Either way, this is a fine solution, even if only temporary.

Will ask a colleague to review the PR, or I can get to it tomorrow.

@findleyr findleyr requested a review from jba December 10, 2025 15:42
@jonathanhefner
Copy link
Member Author

Thanks! Will we be the only SDK with this solution? I think we'd actually wanted to contribute official docs, but are slim on bandwidth at the moment.

Yes, but I've ended up having to take a unique approach for each SDK (because of ecosystem idioms, as well as maintainer buy-in), so I think that's fine.

My naive understanding was that hosting markdown files directly in GitHub's UI was typical for Go packages, but I am not a regular Go developer. If you would prefer to have the docs/ markdown files fully rendered at https://modelcontextprotocol.github.io/go-sdk/ instead of a redirect, I can pursue that approach.

@findleyr
Copy link
Contributor

My naive understanding was that hosting markdown files directly in GitHub's UI was typical for Go packages, but I am not a regular Go developer.

I think Go projects also want to use nicely formatted HTML when they can, but markdown works in a pinch. It's only typical in the sense that Go developers often prefer the simplest solution, even if it's not pretty :)

Many projects rely solely on their package documentation, but that will not suffice for correlating MCP features with API. This is why we added the markdown docs. Your solution is fine for now, and thanks again for contributing.

Took a quick skim, and this all looks very reasonable, but I'm a GitHub noob, so need to make sure I understand the implications of permissions, etc (or just verify that this is consistent with other SDKs). Will review tomorrow if @jba or @markus-kusano don't get to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants