-
Notifications
You must be signed in to change notification settings - Fork 203
Context specific readme #499
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Context specific readme #499
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR implements context-specific README generation for different package types (npm, nuget, vsix) by introducing a unified template system with conditional content rendering based on the target package. It also updates the NuGet packaging script to dynamically select appropriate logos based on the package ID prefix.
- Adds a comprehensive MERGED.md template with annotation-based content filtering
- Creates a PowerShell script to process README templates and generate package-specific outputs
- Updates NuGet packaging to use Microsoft or Azure logos based on package ID prefix
Reviewed Changes
Copilot reviewed 3 out of 6 changed files in this pull request and generated 5 comments.
File | Description |
---|---|
servers/Azure.Mcp.Server/MERGED.md | Master README template with conditional content annotations for different package types |
eng/scripts/Process-PackageReadMe.ps1 | PowerShell script to process template annotations and generate package-specific READMEs |
eng/scripts/Pack-Nuget.ps1 | Updated to dynamically select package icon based on PackageId prefix |
ff750c1
to
73d6f57
Compare
93ab57e
to
2af0aeb
Compare
2838e16
to
95a86d5
Compare
Start to templatize Readme Created Shared Readme Add comment annotation to README.md to allow update at run time Use Azure or Microsoft Icon Updates to README.md More readme updates Use readme processing script at pack time Remmove old README.md Update Azure.Mco.Server README.md Update README.md and ReadMe processing script Remove spaces from Insert Payload Add comments in Process-PackageReadMe script
95a86d5
to
ad22f39
Compare
547c207
to
ea5df95
Compare
@weshaggard @hallipr @KarishmaGhiya @chidozieononiwu - this really complicated the README.md... |
I wish we merged #578 before this. I think your formatting is about to need to be re-reviewed for each package |
This reverts commit c2fce5b.
What does this PR do?
Pack-Nuget.ps1
so that it selects Azure or Microsoft Logo based on the MCP.Server PackageIdnpm|nuget|vsix
GitHub issue number?
#475