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 |
…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>
Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
|
@jeffhandley at this point I'm not sure why we have the READMEs in each library folder. Can we just delete those and have the nuget package for each just include the main readme? |
|
@stephentoub yeah, great point. Sounds good! What we've done in dotnet/runtime is name the package readme as PACKAGE.md, which has also been helpful for us to recognize which is when editing. So I suggest:
In dotnet/runtime, we use some arcade/common build infrastructure to achieve that. Here, it should be something like this: <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<!-- NuGet will look for this path *inside the nupkg* -->
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>
<ItemGroup>
<!-- Take PACKAGE.md from the repo and pack it as README.md at the nupkg root -->
<None Include="PACKAGE.md"
Pack="true"
PackagePath="README.md"
PackageCopyToOutput="true" />
</ItemGroup>
</Project> |
@copilot, please do this |
Replace three individual package README.md files with a single shared PACKAGE.md in the src folder. All three csproj files now reference ../PACKAGE.md and pack it as README.md inside the NuGet package. Also update the top-level README.md to use absolute docs site URLs for the Documentation links since the per-package READMEs no longer exist. Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Done in |
Simplifies the package READMEs for
ModelContextProtocol.Core,ModelContextProtocol, andModelContextProtocol.AspNetCoreto match the pattern established in #1387 for the root README. Consolidates all three per-package READMEs into a single sharedsrc/PACKAGE.mdthat is packed asREADME.mdinto each NuGet package. Also updates the top-levelREADME.mdwith consistent documentation links.src/PACKAGE.mdas the single shared NuGet package README with simplified content, Packages section with absolute docs site URLs, Getting Started link, and "Official MCP Documentation" / "MCP C# SDK Documentation" linkssrc/ModelContextProtocol/README.md,src/ModelContextProtocol.Core/README.md, andsrc/ModelContextProtocol.AspNetCore/README.mdfiles.csprojfiles to reference../PACKAGE.mdand pack it asREADME.mdinside the NuGet packageREADME.md: renamed "Official Documentation" to "Official MCP Documentation", added "MCP C# SDK Documentation" link, and changed package Documentation links to use absolute docs site URLs💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.