Skip to content

docs: add a starter docs surface for schema and TypeScript reference#1

Draft
auscaster wants to merge 2 commits intomainfrom
docs/docs-refresh-sourcey-mcp-schema
Draft

docs: add a starter docs surface for schema and TypeScript reference#1
auscaster wants to merge 2 commits intomainfrom
docs/docs-refresh-sourcey-mcp-schema

Conversation

@auscaster
Copy link
Copy Markdown
Member

I put together a small docs starter patch for mcp-schema that 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.json structure, exported types, and package usage, and includes a rendered docs build for review: https://sourcey.com/previews/sourcey/mcp-schema/index.html

Preview Site

https://sourcey.com/previews/sourcey/mcp-schema/index.html

Integration Path

Pathway: starter_patch

Recommended delivery: pull_request

Upstream 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

  • .gitignore
  • docs/changelog.md
  • docs/getting-started.md
  • docs/index.md
  • docs/readme.md
  • docs/schema-reference.md
  • docs/sourcey.config.ts
  • docs/typescript.md
  • docs/usage.md

Source issue: https://github.com/sourcey/sourcey.com/issues/3

@auscaster auscaster force-pushed the docs/docs-refresh-sourcey-mcp-schema branch from af34f4b to 85a907b Compare April 27, 2026 09:20
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.

1 participant