docs: add a starter docs surface for schema and TypeScript reference#1
Draft
docs: add a starter docs surface for schema and TypeScript reference#1
Conversation
af34f4b to
85a907b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I put together a small docs starter patch for
mcp-schemathat stays close to the current repo shape while making the schema and TypeScript reference easier to review. It keeps README and changelog visible, adds focused pages for getting started,mcp.jsonstructure, exported types, and package usage, and includes a rendered docs build for review: https://sourcey.com/previews/sourcey/mcp-schema/index.htmlPreview Site
https://sourcey.com/previews/sourcey/mcp-schema/index.html
Integration Path
Pathway:
starter_patchRecommended delivery:
pull_requestUpstream shape: Start with the smallest substantive docs footprint that can land cleanly while still proving the full preview.
Why this path: The repo needs a complete docs experience, but the safest first upstream step is a bounded starter patch before proposing a broader docs-site adoption.
Upstream footprint: Adds a small but substantive docs surface, usually focused on the front door, getting started flow, and the most important authored pages.
Maintainer burden: low
Reversibility: high
Follow-up path: If maintainers like the direction, expand the starter patch toward a sidecar_site or native_patch follow-up.
What Changed
Applied one bounded revision pass to preserve README.md as an explicit visible page in the built docs surface and to reduce index-title duplication risk by removing the config-level site name. Updated navigation to include a dedicated README page, added a docs/readme.md page grounded directly in the repository README content, and expanded featured search pages to include it. No broader IA or prose scope was added beyond the critique requirements.
Proposed Files
Source issue: https://github.com/sourcey/sourcey.com/issues/3