Add readme to nuget packages #121
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Regenhardt
requested changes
Mar 18, 2024
| @@ -4,6 +4,7 @@ | |||
|
|
|||
| <PackageTags>NuGet</PackageTags> | |||
| <Description>The core libraries that power BaGetter.</Description> | |||
| <PackageReadmeFile>readme.md</PackageReadmeFile> | |||
There was a problem hiding this comment.
I don't think this is always the right way. BaGetter.Core has a readme describing the source folder contents, which does not fit as package description on the gallery page. I'm not sure how to handle this though, since the readme here does fit a github page, describing its contents. Maybe an additional PackageReadme.md file for information to display on the gallery page?
| <PackageTags>NuGet</PackageTags> | ||
| <Description>The libraries to host BaGetter on MySQL.</Description> | ||
| <PackageReadmeFile>readme.md</PackageReadmeFile> |
There was a problem hiding this comment.
The db provider projects have no fitting readme files either. They just describe how to add a migration for each db provider.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the already existing
readmefiles of the various packages to those packages.Currently only the
descriptionis displayed in the official gallery.example images (from BaGetter gallery)
before
after