Feature documentation

[findleyr]

The SDK supports ~everything in the spec, but has a large API and package documentation can be overwhelming.

At the same time...

1. We have a large number of tests and examples, and
2. Most users only need to interact with a small fraction of the API for the feature they want, and yet it's hard to determine which aspects of the API are necessary.

Furthermore, there is confusion around where to look: as mentioned above, the package docs are too large, and yet the README is too sparse.

Prior to the release, I plan to write documentation oriented not around the API, but around the MCP spec. For each high-level aspect of the spec, I'll write a snippet explaining how to implement it using the SDK. I'll also features of the SDK that aren't explicitly in the spec, such as stateless mode.

Building on the current README generation., I plan to use weave to embed snippets from our existing examples.

We should have a table in the README, linking to relevant markdown files in the doc/ directory.
We may mirror a subset of this to package docs.

I'll put the scaffolding in place, but then this could be a great area for contribution.

[findleyr]

See also modelcontextprotocol/csharp-sdk#708.

[jba]

I wouldn't call this a release blocker. We should not delay the (already delayed) release because we're missing a few docs. They can land next week.

[findleyr]

I disagree. I think the feature docs are perhaps the most thing to include in the release, when people are checking out the SDK. If we say it's v1.0.0, and then people try to do something and can't figure out how, we've missed an opportunity.

The first batch of these docs took me a day, and most of that was figuring out the framework. I'll do the rest of them this week, in chunks.