Skip to content

docs: publish user docs with mkdocs#843

Open
CMLKevin wants to merge 1 commit intomodelcontextprotocol:mainfrom
CMLKevin:worker-a/wi-go-sdk-835
Open

docs: publish user docs with mkdocs#843
CMLKevin wants to merge 1 commit intomodelcontextprotocol:mainfrom
CMLKevin:worker-a/wi-go-sdk-835

Conversation

@CMLKevin
Copy link

@CMLKevin CMLKevin commented Mar 13, 2026

Summary

  • add mkdocs.yml so the docs directory builds as a MkDocs site
  • update the publish-docs workflow to build and publish ./site instead of pushing raw ./docs
  • add docs/index.md as the user-docs homepage with a pkg.go.dev API reference link

Testing

  • python3 -m venv .tmp-mkdocs-venv && . .tmp-mkdocs-venv/bin/activate && python -m pip install mkdocs && mkdocs build
  • git diff --check

Fixes #835

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you take a look at the files defined for Python and Java:

https://github.com/modelcontextprotocol/python-sdk/blob/main/mkdocs.yml
https://github.com/modelcontextprotocol/java-sdk/blob/main/mkdocs.yml

We don't have to replicate every customization they have, but they should contain a good baseline for the configuration file – especially look for things that are defined in both.

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.

Configure mkdocs to serve the user documentation

2 participants