docs(packaging): per-package READMEs + English descriptions (for 1.0.1)#36
Merged
Merged
Conversation
The published 1.0.0 packages showed no README and a Spanish <Description> (a residue of the English migration that lived in the .csproj, not a comment). Fix both in the package metadata so the next release (1.0.1) ships correct, embedded content. - Directory.Build.props: PackageReadmeFile=README.md + pack each publishable library's own README.md into its .nupkg. - Six per-package README.md (Core, Versioning, Server, Loro, Persistence.EFCore, Persistence.Redis): what it provides, install, a short snippet, links (absolute URLs so they resolve on nuget.org). - Translated the six <Description> values to English. Verified: dotnet pack embeds README.md (<readme> in the .nuspec) and the English description; markdownlint clean; build green. 1.0.0 packages are immutable, so this lands in 1.0.1. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
The published 1.0.0 packages show no README and a Spanish
<Description>(a residue of the English migration that lived in the.csproj, not a comment). This fixes both in the package metadata.Changes
Directory.Build.props:PackageReadmeFile=README.md+ pack each publishable library's ownREADME.mdinto its.nupkg.README.md(Core, Versioning, Server, Loro, Persistence.EFCore, Persistence.Redis): what it provides, install, a short snippet, and links (absolute GitHub/nuget URLs so they resolve on nuget.org).<Description>values to English.Verification
dotnet packembedsREADME.md(<readme>README.md</readme>in the.nuspec) and emits the English<description>; markdownlint clean; build green.Note
1.0.0 packages are immutable, so this ships in 1.0.1. (nuget.org's web "add a README" can patch the displayed README of 1.0.0 in the meantime, but 1.0.1 fixes README and description embedded.)
🤖 Generated with Claude Code