Skip to content
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

Added a readme file to the NuGet packages #1400

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Guiorgy
Copy link

@Guiorgy Guiorgy commented Feb 14, 2025

With the Visual Studio 17.13 update the NuGet package manager/browser shows a preview of the included readme.

Might want to consider embedding a readme with the packages moving forward, otherwise Visual Studio shows the following:

missing readme preview in visual studio

Ideally, each package would have a dedicated readme, but that would probably be too annoying to maintain, so for now I included the same file in every package.

I included the readme.source.md file, though if you'd prefer readme.md instead, I can change that.

@Guiorgy
Copy link
Author

Guiorgy commented Feb 14, 2025

@dotnet-policy-service agree

@SimonCropp
Copy link
Member

doesnt this make it difficult NuGet/NuGetGallery#8644 ?

@SimonCropp
Copy link
Member

also Mermaid diagrams are not supported NuGet/NuGetGallery#8942

@Guiorgy
Copy link
Author

Guiorgy commented Feb 15, 2025

Good point

@SimonCropp
Copy link
Member

so whats the way forward?

@Guiorgy
Copy link
Author

Guiorgy commented Feb 21, 2025

There are several options:

  • Keep things as they were (EDIT: In other words close the PR)
  • Embed one of the readmes as they are ignoring the problems
  • Make a smaller simplified readme for embedding into the NuGet packages

Your choice really.

@SimonCropp
Copy link
Member

Make a smaller simplified readme for embedding into the NuGet packages

happy to consider a PR that does this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants