Simplify and update package README.md files for stable release#1388
Simplify and update package README.md files for stable release#1388
Conversation
…l README - ModelContextProtocol.Core/README.md: Remove preview note, update NuGet badge to stable, remove --prerelease from install - ModelContextProtocol.AspNetCore/README.md: Remove preview note, fix NuGet badge to correct package and stable, remove --prerelease from install - ModelContextProtocol/README.md: New README with hosting example from getting started docs - ModelContextProtocol.csproj: Reference new local README.md instead of root README.md Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
|
@copilot Review the changes made in #1387 and apply similar editing here, simplifying the package READMEs in the same manner. Instead of including Getting Started content with samples in the package README files, link to the Getting Started documentation page introduced and referenced in that PR. Also look change "our API documentation" to "the API documentation" as was done in the other PR. |
Remove inline code samples from all three package READMEs and link to the Getting Started documentation page instead. Change "our" to "the" for API documentation references. Tighten package descriptions. Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
Simplified all three package READMEs to match the pattern from #1387 in |
| public static string Echo(string message) => $"hello {message}"; | ||
| } | ||
| ``` | ||
| - [Official Documentation](https://modelcontextprotocol.io/) |
There was a problem hiding this comment.
@copilot Each place where we list these links, change "Official Documentation" to "Official MCP Documentation", and add a link after it for the "MCP C# SDK Documentation" that links to https://modelcontextprotocol.github.io/csharp-sdk/.
There was a problem hiding this comment.
Updated all three package READMEs in 1a8bf62: renamed "Official Documentation" to "Official MCP Documentation" and added "MCP C# SDK Documentation" link to https://modelcontextprotocol.github.io/csharp-sdk/ after it.
…ation" and add "MCP C# SDK Documentation" link Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
…umentation URLs Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
There was a problem hiding this comment.
@stephentoub et al - this forks the README for the repo and the README for the MCP package whereas we previously reused the same doc for both purposes. With the reduced content, I'm good with the split as this allows the links to be set up appropriately for each of the two contexts.
Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
Simplifies the package READMEs for
ModelContextProtocol.Core,ModelContextProtocol, andModelContextProtocol.AspNetCoreto match the pattern established in #1387 for the root README. Also updates the top-levelREADME.mdwith consistent documentation links.src/ModelContextProtocol.Core/README.md: removed preview note, updated NuGet badge to stable, removed--prereleasefrom install command, removed inline code samples and linked to Getting Started docs instead, changed "our" to "the" for API documentation referencesrc/ModelContextProtocol.AspNetCore/README.md: removed preview note, fixed NuGet badge to reference correct package, removed--prereleasefrom install command, removed inline code samples and linked to Getting Started docs instead, changed "our" to "the" for API documentation referencesrc/ModelContextProtocol/README.mdwith simplified content linking to Getting Started docs, including a Packages section with absolute URLs to the docs sitesrc/ModelContextProtocol/ModelContextProtocol.csprojto reference the new local README.md instead of the root README.md💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.