Move Registry docs over to modelcontextprotocol.io #542
Description
From @dsp-ant:
... I want to make sure people understand that the registry exists and how to use it, by visiting modelcontextprotocol.io ...
From @domdomegg:
I think the docs should move to modelcontextprotocol.io in the long term, or failing that then something like registry.modelcontextprotocol.io/docs.
The current state works, but is pretty janky to navigate around in the GitHub UI. And it's poor for SEO (which hurts both things like Google search, and models being able to read it).
To explain why it's there right now, for velocity we found keeping the docs together with registry code was helpful - and meant you could align code + docs changes, and don't have to get a docs maintainer stamp on each corresponding docs change. There were also concerns from theo and others I think about it being on the main docs site making it more formal, and maybe being inappropriate for a preview launch. Plus just questions about whether it should be it's own category of docs, some subpart somewhere else, whether the specs should go under the 'specification' tab and a whole bunch of other Qs that dragged it out longer and we didn't want to block on these to preview launch.
dsp-ant:
Yeah totally. I would love all docs to live in modelcontextprotocol.io or registry.modelcontextprotocol.io. Just let me know waht you prefer. Agreed on velocity and stuff. It's a bit annoying to have it in a separate repo, but oh well
domdomegg:
Yeah. Uncertain if a terrible idea that overcomplicates things (quite plausibly) but potentially one-way syncing changes from registry => modelcontextprotocol/docs might mean we get some of the benefits of being able to review code + docs changes together.
Another easier alternative is just to move docs there completely, and put them all under paths where CODEOWNERS allows registry-wg team to approve, rather than blocking on docs maintainers. And have it be a norm that when reviewing/merging the code PR you also review/merge the docs PR.
I also think keeping the docs in the repo helps keep things in sync from both maintainer and contributor perspective 👍
That said, would it work if the sync from registry to docs happens automatically on every registry release by opening a PR against mcp/docs?
References:
- https://discord.com/channels/1358869848138059966/1369487942862504016/1416005469230727290
- https://discord.com/channels/1358869848138059966/1369487942862504016/1420151416332226562
Pulling this into an Issue as the full scope of achieving the final state here is likely a larger chunk of work I'm not sure exactly when we'll prioritize bringing to completion.